Alma logo
API docs by Redocly

Auction API (1.0)

Download OpenAPI specification:Download

Introduction

Auction API allows fetching auction details, including offers, for a specified realty and joining as follower to the bidding.

Contact

If you have any questions, comments or feedback regarding our APIs, please contact developer@ovipro.fi.

Auction (authenticated)

Auction API allows authenticated users to list and update auction followers.

Fetch auction followers

Fetch auction details for a specified realty.

Authorizations:
bearerAuth
path Parameters
realtyFriendlyId
required
string
Example: 7234316

Human-readable identifier for a realty.

header Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "realtyFriendlyId": "40142361",
  • "followerCount": 2,
  • "followers": [
    ]
}

Update auction follower

Update the follower details.

Authorizations:
bearerAuth
path Parameters
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.

header Parameters
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 schema: application/json

Request body for updating the follower.

partyId
required
string <uuid> (PartyId)

Identifies the party linked to the follower.

Responses

Request samples

Content type
application/json
{
  • "partyId": "abd2b0c4-4bd7-40a2-8b14-674354afddbd"
}

Response samples

Content type
application/json
{
  • "errorCode": "BAD_REQUEST_PARAMETERS",
  • "message": "Invalid request parameters",
  • "description": "Request parameters are missing or have invalid type.",
  • "errors": [
    ]
}

Delete auction follower

Delete auction follower.

Authorizations:
bearerAuth
path Parameters
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.

header Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "errorCode": "BAD_REQUEST_PARAMETERS",
  • "message": "Invalid request parameters",
  • "description": "Request parameters are missing or have invalid type.",
  • "errors": [
    ]
}

Auction (unauthenticated)

Auction API allows unauthenticated users to list auction details and subscribe and unsubscribe to auction notifications.

Fetch auction realties

Fetch auction details for a specified realty.

path Parameters
realtyFriendlyId
required
string
Example: 7234316

Human-readable identifier for a realty.

header Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "realtyFriendlyId": "1234567",
  • "realty": {
    },
  • "agencyOffice": {},
  • "auction": {
    }
}

Create auction followers

Join as a follower to the auction of a specified realty.

path Parameters
realtyFriendlyId
required
string
Example: 7234316

Human-readable identifier for a realty.

header Parameters
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 schema: application/json

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.

Responses

Request samples

Content type
application/json
{
  • "follower": {
    },
  • "messageToAgent": "I would like to know more about the realty.",
  • "isFamiliarWithTheRealty": true
}

Response samples

Content type
application/json
{
  • "followerId": "f1a2b3c4-d5e6-7f8g-9h0i-1j2k3l4m5n6o",
  • "unSubscriptionKey": "a152fa4c-cff0-44c8-aa37-978112d24a4c"
}

Unsubscribe from auction notifications of a realty

Unsubscribe follower specified by unSubscriptionKey from the auction notifications of a realty.

query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "errorCode": "TOO_MANY_REQUESTS",
  • "message": "The client has send too many requests in a given time. The next valid request time is specified by the Retry-After header."
}