Referencia de la API bidauction

Buscar en todos los 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.

Parámetros

Nombre	Tipo	Obligatorio	Predeterminado	Descripción
`page`	`int`	`No`	`1`	One-based page number.

Ejemplo de solicitud (cURL)

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

Respuesta

JSON

See the shared response schema and synthetic example.

Campos de respuesta

Campo	Tipo	Obligatorio	Descripción
`$`	`bidauction_get_list_Response`	`si`
`$.oneOf[0]`		`si`
`$.oneOf[0].allOf[0]`	`object`	`si`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`si`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`si`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`si`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`si`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`si`
`$.oneOf[0].allOf[1].Payload`	`object`	`si`
`$.oneOf[0].allOf[1].Payload.items`	`array`	`si`
`$.oneOf[0].allOf[1].Payload.items[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.items[].roundID`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.items[].bidID`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.items[].venue`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.items[].request`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.items[].startTime`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.items[].endTime`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.items[].bidAmountCents`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.items[].leadingCents`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.items[].nextCents`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.items[].closesAt`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.items[].participating`	`boolean`	`si`
`$.oneOf[0].allOf[1].Payload.items[].leading`	`boolean`	`si`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers`	`array`	`si`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[].id`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[].amountCents`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[].state`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[].refundCents`	`integer`	`si`
`$.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`	`si`
`$.oneOf[0].allOf[1].Payload.pageSize`	`= 25`	`si`
`$.oneOf[0].allOf[1].Payload.total`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.serverTime`	`integer`	`si`
`$.oneOf[1]`	`object`	`si`
`$.oneOf[1].RequestUserAlias`	`string`	`si`
`$.oneOf[1].RequestPath`	`string \| null`	`si`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`si`
`$.oneOf[1].ResponseCode`	`integer`	`si`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`si`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`si`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`si`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`si`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Ejemplo de respuesta

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

Documentación del endpoint legible por máquinas

GET

/v1/bidauction/get_state

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

Parámetros

Nombre	Tipo	Obligatorio	Predeterminado	Descripción
`bidID`	`int`	`si`	`—`	Customer bid ID.
`roundID`	`int`	`No`	`0`	Optional round to retain its outcome after closing. Zero selects the active round.

Ejemplo de solicitud (cURL)

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

Respuesta

JSON

See the shared response schema and synthetic example.

Campos de respuesta

Campo	Tipo	Obligatorio	Descripción
`$`	`bidauction_get_state_Response`	`si`
`$.oneOf[0]`		`si`
`$.oneOf[0].allOf[0]`	`object`	`si`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`si`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`si`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`si`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`si`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`si`
`$.oneOf[0].allOf[1].Payload`	`object`	`si`
`$.oneOf[0].allOf[1].Payload.venue`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.startTime`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.endTime`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.bidID`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.bidAmountCents`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.roundID`		`si`
`$.oneOf[0].allOf[1].Payload.roundID.anyOf[0]`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.roundID.anyOf[1]`	`null`	`si`
`$.oneOf[0].allOf[1].Payload.state`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.serverTime`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.closesAt`		`si`
`$.oneOf[0].allOf[1].Payload.closesAt.anyOf[0]`	`DatabaseInteger`	`si`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.closesAt.anyOf[0].oneOf[0]`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.closesAt.anyOf[0].oneOf[1]`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.closesAt.anyOf[1]`	`null`	`si`
`$.oneOf[0].allOf[1].Payload.enabled`	`boolean`	`si`
`$.oneOf[0].allOf[1].Payload.openingCents`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.incrementCents`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.leadingCents`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.nextCents`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.estimatedFeesCents`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.remainingCents`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.leading`	`boolean`	`si`
`$.oneOf[0].allOf[1].Payload.priorityUntil`	`null`	`si`
`$.oneOf[0].allOf[1].Payload.priorityMine`	`= false`	`si`
`$.oneOf[0].allOf[1].Payload.ownOffers`	`array`	`si`
`$.oneOf[0].allOf[1].Payload.ownOffers[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.ownOffers[].id`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.ownOffers[].amountCents`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.ownOffers[].state`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.ownOffers[].refundCents`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.eligibilityError`		`si`
`$.oneOf[0].allOf[1].Payload.eligibilityError.anyOf[0]`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.eligibilityError.anyOf[1]`	`null`	`si`
`$.oneOf[0].allOf[1].Payload.holdAppointmentID`		`si`
`$.oneOf[0].allOf[1].Payload.holdAppointmentID.anyOf[0]`	`DatabaseInteger`	`si`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.holdAppointmentID.anyOf[0].oneOf[0]`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.holdAppointmentID.anyOf[0].oneOf[1]`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.holdAppointmentID.anyOf[1]`	`null`	`si`
`$.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`	`si`
`$.oneOf[1].RequestUserAlias`	`string`	`si`
`$.oneOf[1].RequestPath`	`string \| null`	`si`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`si`
`$.oneOf[1].ResponseCode`	`integer`	`si`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`si`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`si`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`si`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`si`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Ejemplo de respuesta

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

Documentación del endpoint legible por máquinas

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.

Parámetros

Nombre	Tipo	Obligatorio	Predeterminado	Descripción
`bidID`	`int`	`si`	`—`	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.

Ejemplo de solicitud (cURL)

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

Respuesta

JSON

See the shared response schema and synthetic example.

Campos de respuesta

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

Ejemplo de respuesta

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

Documentación del endpoint legible por máquinas