Référence de l’API bidauction

Rechercher dans tous les points de terminaison

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

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`page`	`int`	`Non`	`1`	One-based page number.

Exemple de requête (cURL)

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

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

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

Exemple de réponse

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

Documentation du point de terminaison lisible par machine

GET

/v1/bidauction/get_state

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

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`bidID`	`int`	`Oui`	`—`	Customer bid ID.
`roundID`	`int`	`Non`	`0`	Optional round to retain its outcome after closing. Zero selects the active round.

Exemple de requête (cURL)

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

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

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

Exemple de réponse

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

Documentation du point de terminaison lisible par machine

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.

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`bidID`	`int`	`Oui`	`—`	Customer bid ID.
`negativeProceedsAccepted`	`bool`	`Non`	`false`	Explicit acknowledgment that total estimated cost can exceed payout.
`isWritingRequest`	`bool`	`Non`	`false`	Must be true to create a checkout.

Exemple de requête (cURL)

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

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

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

Exemple de réponse

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

Documentation du point de terminaison lisible par machine