bidauction API reference | AppointmentTrader

Search all endpoints

/v1/bidauction/

GET

/v1/bidauction/get_list

Visible paid live auctions, with the acting seller's accepted participation first, then earliest closing. Includes finalizing rounds. Returns 25 cards per page, serverTime, page and total. No competitor identities.

Parameters

Name	Type	Required	Default	Description
`page`	`int`	`No`	`1`	One-based page number.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/bidauction/get_list' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'page={{page}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`bidauction_get_list_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.items`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.items[].roundID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].bidID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].venue`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].request`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].startTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].endTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].bidAmountCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].leadingCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].nextCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].closesAt`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].participating`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].leading`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[].amountCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[].state`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[].refundCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].buyerIdentityHidden`	`boolean`	`No`	True when the authenticated viewer cannot see the buyer during the current response race.
`$.oneOf[0].allOf[1].Payload.items[].buyerIdentityHiddenUntil`	`integer \| null`	`No`	Saved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
`$.oneOf[0].allOf[1].Payload.page`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.pageSize`	`= 25`	`Yes`
`$.oneOf[0].allOf[1].Payload.total`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.serverTime`	`integer`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bidauction/get_list",
    "RequestUserAlias": "example-user",
    "Payload": {
        "items": [],
        "page": 1,
        "pageSize": 25,
        "total": 0,
        "serverTime": 0
    }
}

Machine-readable endpoint documentation

GET

/v1/bidauction/get_state

Auction price, fixed deadline and the acting seller's own offers only. Cash amounts are USD cents.

Parameters

Name	Type	Required	Default	Description
`bidID`	`int`	`Yes`	`—`	Customer bid ID.
`roundID`	`int`	`No`	`0`	Optional round to retain its outcome after closing. Zero selects the active round.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/bidauction/get_state' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'roundID={{roundID}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`bidauction_get_state_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.venue`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.startTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.endTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bidID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bidAmountCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.roundID`		`Yes`
`$.oneOf[0].allOf[1].Payload.roundID.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.roundID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.state`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.serverTime`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.closesAt`		`Yes`
`$.oneOf[0].allOf[1].Payload.closesAt.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.closesAt.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.closesAt.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.closesAt.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.enabled`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.openingCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.incrementCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.leadingCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.nextCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.estimatedFeesCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.remainingCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.leading`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.priorityUntil`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.priorityMine`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.ownOffers`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ownOffers[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.ownOffers[].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ownOffers[].amountCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ownOffers[].state`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ownOffers[].refundCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.eligibilityError`		`Yes`
`$.oneOf[0].allOf[1].Payload.eligibilityError.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.eligibilityError.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.holdAppointmentID`		`Yes`
`$.oneOf[0].allOf[1].Payload.holdAppointmentID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.holdAppointmentID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.holdAppointmentID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.holdAppointmentID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.buyerIdentityHidden`	`boolean`	`No`	True when the authenticated viewer cannot see the buyer during the current response race.
`$.oneOf[0].allOf[1].Payload.buyerIdentityHiddenUntil`	`integer \| null`	`No`	Saved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bidauction/get_state",
    "RequestUserAlias": "example-user",
    "Payload": {
        "venue": "synthetic-example",
        "startTime": "synthetic-example",
        "endTime": "synthetic-example",
        "bidID": 0,
        "bidAmountCents": 0,
        "roundID": 0,
        "state": "synthetic-example",
        "serverTime": 0,
        "closesAt": 0,
        "enabled": false,
        "openingCents": 0,
        "incrementCents": 0,
        "leadingCents": 0,
        "nextCents": 0,
        "estimatedFeesCents": 0,
        "remainingCents": 0,
        "leading": false,
        "priorityUntil": null,
        "priorityMine": false,
        "ownOffers": [],
        "eligibilityError": "synthetic-example",
        "holdAppointmentID": 0
    }
}

Machine-readable endpoint documentation

POST

/v1/bidauction/set_checkout

Creates a seller-bound checkout for the full next cash offer. This does not reserve a bid or the leading position. Normal fulfillment fees are additional. Outbid or unusable card payments return to AT balance.

Parameters

Name	Type	Required	Default	Description
`bidID`	`int`	`Yes`	`—`	Customer bid ID.
`negativeProceedsAccepted`	`bool`	`No`	`false`	Explicit acknowledgment that total estimated cost can exceed payout.
`isWritingRequest`	`bool`	`No`	`false`	Must be true to create a checkout.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/bidauction/set_checkout' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'negativeProceedsAccepted={{negativeProceedsAccepted}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`bidauction_set_checkout_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.checkoutURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.amountCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.expiresAt`	`integer`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bidauction/set_checkout",
    "RequestUserAlias": "example-user",
    "Payload": {
        "checkoutURL": "synthetic-example",
        "amountCents": 0,
        "expiresAt": 0
    }
}

Machine-readable endpoint documentation