Справочник API bidauction

Поиск по всем методам

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

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`page`	`int`	`Нет`	`1`	One-based page number.

Пример запроса (cURL)

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

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно	Описание
`$`	`bidauction_get_list_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.items`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.items[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.items[].roundID`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].bidID`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].venue`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].request`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].startTime`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].endTime`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].bidAmountCents`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].leadingCents`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].nextCents`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].closesAt`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].participating`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].leading`	`boolean`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[].id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[].amountCents`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[].state`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[].refundCents`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].buyerIdentityHidden`	`boolean`	`Нет`	True when the authenticated viewer cannot see the buyer during the current response race.
`$.oneOf[0].allOf[1].Payload.items[].buyerIdentityHiddenUntil`	`integer \| null`	`Нет`	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`	`Да`
`$.oneOf[0].allOf[1].Payload.pageSize`	`= 25`	`Да`
`$.oneOf[0].allOf[1].Payload.total`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.serverTime`	`integer`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

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

Машиночитаемая документация метода

GET

/v1/bidauction/get_state

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

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`bidID`	`int`	`Да`	`—`	Customer bid ID.
`roundID`	`int`	`Нет`	`0`	Optional round to retain its outcome after closing. Zero selects the active round.

Пример запроса (cURL)

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

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

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

Пример ответа

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

Машиночитаемая документация метода

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.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`bidID`	`int`	`Да`	`—`	Customer bid ID.
`negativeProceedsAccepted`	`bool`	`Нет`	`false`	Explicit acknowledgment that total estimated cost can exceed payout.
`isWritingRequest`	`bool`	`Нет`	`false`	Must be true to create a checkout.

Пример запроса (cURL)

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

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`bidauction_set_checkout_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.checkoutURL`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.amountCents`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.expiresAt`	`integer`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

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

Машиночитаемая документация метода