Download OpenAPI specification:Download
Auction API allows fetching auction details, including offers, for a specified realty and joining as follower to the bidding.
If you have any questions, comments or feedback regarding our APIs, please contact developer@ovipro.fi.
Fetch auction details for a specified realty.
realtyFriendlyId required | string Example: 7234316 Human-readable identifier for a realty. |
Request-ID required | string <uuid> Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9 A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes. |
{- "realtyFriendlyId": "40142361",
- "followerCount": 2,
- "followers": [
- {
- "followerId": "b5dbeed0-8063-40f1-bc82-868f9cdc59d6",
- "agencyOfficeId": "13f83770-1df0-4771-9b84-49060483f6ec",
- "partyId": "2cf9dbe2-c0d7-4e9e-a917-d1c67aa1cc0d",
- "follower": {
- "firstName": "John",
- "lastName": "Doe",
- "phone": "+358401234567",
- "email": "john.doe@example.com",
- "address": {
- "streetAddress": "Mannerheimintie 1",
- "postcode": "00100",
- "postalArea": "Helsinki"
}
}, - "messageToAgent": "I would like to know more about the realty.",
- "isFamiliarWithTheRealty": true,
- "creationTime": "2020-01-01T12:00:00Z",
- "modificationTime": "2020-01-01T12:00:00Z"
}, - {
- "followerId": "972b4a1c-50fd-4e37-b769-b31f58315bea",
- "agencyOfficeId": "13f83770-1df0-4771-9b84-49060483f6ec",
- "follower": {
- "firstName": "Jane",
- "lastName": "Doe",
- "phone": "+358401234568",
- "email": "jane.doe@example.com",
- "address": {
- "streetAddress": "Mannerheimintie 2",
- "postcode": "00101",
- "postalArea": "Helsinki"
}
}, - "messageToAgent": "I am interested in this property.",
- "isFamiliarWithTheRealty": false,
- "creationTime": "2020-01-01T15:00:00Z",
- "modificationTime": "2020-01-01T16:00:00Z"
}
]
}
Update the follower details.
realtyFriendlyId required | string Example: 7234316 Human-readable identifier for a realty. |
followerId required | string <uuid> Example: 0edb0b12-4048-4908-83db-6e9718dd5536 Unique identifier for the follower. |
Request-ID required | string <uuid> Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9 A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes. |
Request body for updating the follower.
partyId required | string <uuid> (PartyId) Identifies the party linked to the follower. |
{- "partyId": "abd2b0c4-4bd7-40a2-8b14-674354afddbd"
}
{- "errorCode": "BAD_REQUEST_PARAMETERS",
- "message": "Invalid request parameters",
- "description": "Request parameters are missing or have invalid type.",
- "errors": [
- {
- "target": "assignmentId",
- "errorCode": "VALUE_REQUIRED",
- "message": "Mandatory request parameter assignmentId is missing"
}, - {
- "target": "authorId",
- "errorCode": "INVALID_TYPE",
- "message": "Request parameter authorId must be a string"
}
]
}
Delete auction follower.
realtyFriendlyId required | string Example: 7234316 Human-readable identifier for a realty. |
followerId required | string <uuid> Example: 0edb0b12-4048-4908-83db-6e9718dd5536 Unique identifier for the follower. |
Request-ID required | string <uuid> Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9 A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes. |
{- "errorCode": "BAD_REQUEST_PARAMETERS",
- "message": "Invalid request parameters",
- "description": "Request parameters are missing or have invalid type.",
- "errors": [
- {
- "target": "assignmentId",
- "errorCode": "VALUE_REQUIRED",
- "message": "Mandatory request parameter assignmentId is missing"
}, - {
- "target": "authorId",
- "errorCode": "INVALID_TYPE",
- "message": "Request parameter authorId must be a string"
}
]
}
Auction API allows unauthenticated users to list auction details and subscribe and unsubscribe to auction notifications.
Fetch auction details for a specified realty.
realtyFriendlyId required | string Example: 7234316 Human-readable identifier for a realty. |
Request-ID required | string <uuid> Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9 A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes. |
{- "realtyFriendlyId": "1234567",
- "auction": {
- "followerCount": 3,
- "auctionOffers": [
- {
- "auctionOfferId": "9238cf7b-b86a-49a5-b54f-cbdfcd03e9c9",
- "buyerId": "5234341",
- "sellingPrice": 190000,
- "debtFreePriceAmount": 230000,
- "currencyCode": "EUR",
- "conditionalOffer": true,
- "offerActivatedTime": "2023-09-15T12:32:28Z"
}
]
}
}
Join as a follower to the auction of a specified realty.
realtyFriendlyId required | string Example: 7234316 Human-readable identifier for a realty. |
Request-ID required | string <uuid> Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9 A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes. |
Request body for joining as a follower to the auction.
required | object (FollowerDetails) Follower details. |
messageToAgent | string (messageToAgent) A message from the follower to the agent. The message can be used to ask questions or to provide additional information. |
isFamiliarWithTheRealty required | boolean (IsFamiliarWithTheRealty) Indicates whether the follower has reviewed the realty or arranged a showing. |
{- "follower": {
- "firstName": "John",
- "lastName": "Doe",
- "phone": "+358401234567",
- "email": "john.doe@example.com",
- "address": {
- "streetAddress": "Mannerheimintie 1",
- "postcode": "00100",
- "postalArea": "Helsinki"
}
}, - "messageToAgent": "I would like to know more about the realty.",
- "isFamiliarWithTheRealty": true
}
{- "followerId": "f1a2b3c4-d5e6-7f8g-9h0i-1j2k3l4m5n6o"
}
Unsubscribe follower specified by unSubscriptionKey from the auction notifications of a realty.
unSubscriptionKey required | string <uuid> Example: unSubscriptionKey=55e05f8a-4fb0-4568-bfa4-b21762e3827b Secret key to authorize the un-subscription of a follower. The key is distributed to the follower through un-subscription link included in the auction emails. |
redirectUrl | string <uri> Example: redirectUrl=https://www.ovipro.fi URL to redirect the user after successful un-subscription. |
Unsubscribed successfully.