API-Referenz: bidauction | AppointmentTrader

Alle Endpunkte durchsuchen

/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.

Parameter

Name	Typ	Erforderlich	Standard	Beschreibung
`page`	`int`	`Nein`	`1`	One-based page number.

Anfragebeispiel (cURL)

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

Rückgabe

JSON

See the shared response schema and synthetic example.

Antwortfelder

Feld	Typ	Erforderlich	Beschreibung
`$`	`bidauction_get_list_Response`	`Ja`
`$.oneOf[0]`		`Ja`
`$.oneOf[0].allOf[0]`	`object`	`Ja`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Ja`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Ja`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Ja`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Ja`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Ja`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Ja`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Ja`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Nein`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Ja`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Nein`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Nein`
`$.oneOf[0].allOf[1]`	`object`	`Ja`
`$.oneOf[0].allOf[1].Payload`	`object`	`Ja`
`$.oneOf[0].allOf[1].Payload.items`	`array`	`Ja`
`$.oneOf[0].allOf[1].Payload.items[]`	`object`	`Nein`
`$.oneOf[0].allOf[1].Payload.items[].roundID`	`integer`	`Ja`
`$.oneOf[0].allOf[1].Payload.items[].bidID`	`integer`	`Ja`
`$.oneOf[0].allOf[1].Payload.items[].venue`	`string`	`Ja`
`$.oneOf[0].allOf[1].Payload.items[].request`	`string`	`Ja`
`$.oneOf[0].allOf[1].Payload.items[].startTime`	`string`	`Ja`
`$.oneOf[0].allOf[1].Payload.items[].endTime`	`string`	`Ja`
`$.oneOf[0].allOf[1].Payload.items[].bidAmountCents`	`integer`	`Ja`
`$.oneOf[0].allOf[1].Payload.items[].leadingCents`	`integer`	`Ja`
`$.oneOf[0].allOf[1].Payload.items[].nextCents`	`integer`	`Ja`
`$.oneOf[0].allOf[1].Payload.items[].closesAt`	`integer`	`Ja`
`$.oneOf[0].allOf[1].Payload.items[].participating`	`boolean`	`Ja`
`$.oneOf[0].allOf[1].Payload.items[].leading`	`boolean`	`Ja`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers`	`array`	`Ja`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[]`	`object`	`Nein`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[].id`	`integer`	`Ja`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[].amountCents`	`integer`	`Ja`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[].state`	`string`	`Ja`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[].refundCents`	`integer`	`Ja`
`$.oneOf[0].allOf[1].Payload.items[].buyerIdentityHidden`	`boolean`	`Nein`	True when the authenticated viewer cannot see the buyer during the current response race.
`$.oneOf[0].allOf[1].Payload.items[].buyerIdentityHiddenUntil`	`integer \| null`	`Nein`	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`	`Ja`
`$.oneOf[0].allOf[1].Payload.pageSize`	`= 25`	`Ja`
`$.oneOf[0].allOf[1].Payload.total`	`integer`	`Ja`
`$.oneOf[0].allOf[1].Payload.serverTime`	`integer`	`Ja`
`$.oneOf[1]`	`object`	`Ja`
`$.oneOf[1].RequestUserAlias`	`string`	`Ja`
`$.oneOf[1].RequestPath`	`string \| null`	`Ja`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Ja`
`$.oneOf[1].ResponseCode`	`integer`	`Ja`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Ja`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Ja`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Ja`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Nein`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Ja`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Nein`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Nein`

Antwortbeispiel

{
    "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
    }
}

Maschinenlesbare Endpunktdokumentation

GET

/v1/bidauction/get_state

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

Parameter

Name	Typ	Erforderlich	Standard	Beschreibung
`bidID`	`int`	`Ja`	`—`	Customer bid ID.
`roundID`	`int`	`Nein`	`0`	Optional round to retain its outcome after closing. Zero selects the active round.

Anfragebeispiel (cURL)

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

Rückgabe

JSON

See the shared response schema and synthetic example.

Antwortfelder

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

Antwortbeispiel

{
    "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
    }
}

Maschinenlesbare Endpunktdokumentation

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.

Parameter

Name	Typ	Erforderlich	Standard	Beschreibung
`bidID`	`int`	`Ja`	`—`	Customer bid ID.
`negativeProceedsAccepted`	`bool`	`Nein`	`false`	Explicit acknowledgment that total estimated cost can exceed payout.
`isWritingRequest`	`bool`	`Nein`	`false`	Must be true to create a checkout.

Anfragebeispiel (cURL)

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

Rückgabe

JSON

See the shared response schema and synthetic example.

Antwortfelder

Feld	Typ	Erforderlich
`$`	`bidauction_set_checkout_Response`	`Ja`
`$.oneOf[0]`		`Ja`
`$.oneOf[0].allOf[0]`	`object`	`Ja`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Ja`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Ja`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Ja`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Ja`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Ja`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Ja`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Ja`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Nein`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Ja`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Nein`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Nein`
`$.oneOf[0].allOf[1]`	`object`	`Ja`
`$.oneOf[0].allOf[1].Payload`	`object`	`Ja`
`$.oneOf[0].allOf[1].Payload.checkoutURL`	`string`	`Ja`
`$.oneOf[0].allOf[1].Payload.amountCents`	`integer`	`Ja`
`$.oneOf[0].allOf[1].Payload.expiresAt`	`integer`	`Ja`
`$.oneOf[1]`	`object`	`Ja`
`$.oneOf[1].RequestUserAlias`	`string`	`Ja`
`$.oneOf[1].RequestPath`	`string \| null`	`Ja`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Ja`
`$.oneOf[1].ResponseCode`	`integer`	`Ja`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Ja`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Ja`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Ja`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Nein`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Ja`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Nein`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Nein`

Antwortbeispiel

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

Maschinenlesbare Endpunktdokumentation