AT AppointmentTrader
登录
当前在线  

/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://cn.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].RequestUserAliasstring 是的
$.oneOf[0].allOf[0].RequestPathstring | null 是的
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" 是的
$.oneOf[0].allOf[0].ResponseCodeinteger 是的
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 是的
$.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].RequestImpersonatedByUserAliasstring 否
$.oneOf[0].allOf[1]object 是的
$.oneOf[0].allOf[1].Payloadobject 是的
$.oneOf[0].allOf[1].Payload.itemsarray 是的
$.oneOf[0].allOf[1].Payload.items[]object 否
$.oneOf[0].allOf[1].Payload.items[].roundIDinteger 是的
$.oneOf[0].allOf[1].Payload.items[].bidIDinteger 是的
$.oneOf[0].allOf[1].Payload.items[].venuestring 是的
$.oneOf[0].allOf[1].Payload.items[].requeststring 是的
$.oneOf[0].allOf[1].Payload.items[].startTimestring 是的
$.oneOf[0].allOf[1].Payload.items[].endTimestring 是的
$.oneOf[0].allOf[1].Payload.items[].bidAmountCentsinteger 是的
$.oneOf[0].allOf[1].Payload.items[].leadingCentsinteger 是的
$.oneOf[0].allOf[1].Payload.items[].nextCentsinteger 是的
$.oneOf[0].allOf[1].Payload.items[].closesAtinteger 是的
$.oneOf[0].allOf[1].Payload.items[].participatingboolean 是的
$.oneOf[0].allOf[1].Payload.items[].leadingboolean 是的
$.oneOf[0].allOf[1].Payload.items[].ownOffersarray 是的
$.oneOf[0].allOf[1].Payload.items[].ownOffers[]object 否
$.oneOf[0].allOf[1].Payload.items[].ownOffers[].idinteger 是的
$.oneOf[0].allOf[1].Payload.items[].ownOffers[].amountCentsinteger 是的
$.oneOf[0].allOf[1].Payload.items[].ownOffers[].statestring 是的
$.oneOf[0].allOf[1].Payload.items[].ownOffers[].refundCentsinteger 是的
$.oneOf[0].allOf[1].Payload.items[].buyerIdentityHiddenboolean 否True when the authenticated viewer cannot see the buyer during the current response race.
$.oneOf[0].allOf[1].Payload.items[].buyerIdentityHiddenUntilinteger | 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.pageinteger 是的
$.oneOf[0].allOf[1].Payload.pageSize = 25 是的
$.oneOf[0].allOf[1].Payload.totalinteger 是的
$.oneOf[0].allOf[1].Payload.serverTimeinteger 是的
$.oneOf[1]object 是的
$.oneOf[1].RequestUserAliasstring 是的
$.oneOf[1].RequestPathstring | null 是的
$.oneOf[1].RequestStatus = "Failed" 是的
$.oneOf[1].ResponseCodeinteger 是的
$.oneOf[1].ResponseMessageAPIResponseMessage 是的
$.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].RequestImpersonatedByUserAliasstring 否
响应示例 
{
    "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://cn.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].RequestUserAliasstring 是的
$.oneOf[0].allOf[0].RequestPathstring | null 是的
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" 是的
$.oneOf[0].allOf[0].ResponseCodeinteger 是的
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 是的
$.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].RequestImpersonatedByUserAliasstring 否
$.oneOf[0].allOf[1]object 是的
$.oneOf[0].allOf[1].Payloadobject 是的
$.oneOf[0].allOf[1].Payload.venuestring 是的
$.oneOf[0].allOf[1].Payload.startTimestring 是的
$.oneOf[0].allOf[1].Payload.endTimestring 是的
$.oneOf[0].allOf[1].Payload.bidIDinteger 是的
$.oneOf[0].allOf[1].Payload.bidAmountCentsinteger 是的
$.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.statestring 是的
$.oneOf[0].allOf[1].Payload.serverTimeinteger 是的
$.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.enabledboolean 是的
$.oneOf[0].allOf[1].Payload.openingCentsinteger 是的
$.oneOf[0].allOf[1].Payload.incrementCentsinteger 是的
$.oneOf[0].allOf[1].Payload.leadingCentsinteger 是的
$.oneOf[0].allOf[1].Payload.nextCentsinteger 是的
$.oneOf[0].allOf[1].Payload.estimatedFeesCentsinteger 是的
$.oneOf[0].allOf[1].Payload.remainingCentsinteger 是的
$.oneOf[0].allOf[1].Payload.leadingboolean 是的
$.oneOf[0].allOf[1].Payload.priorityUntilnull 是的
$.oneOf[0].allOf[1].Payload.priorityMine = false 是的
$.oneOf[0].allOf[1].Payload.ownOffersarray 是的
$.oneOf[0].allOf[1].Payload.ownOffers[]object 否
$.oneOf[0].allOf[1].Payload.ownOffers[].idinteger 是的
$.oneOf[0].allOf[1].Payload.ownOffers[].amountCentsinteger 是的
$.oneOf[0].allOf[1].Payload.ownOffers[].statestring 是的
$.oneOf[0].allOf[1].Payload.ownOffers[].refundCentsinteger 是的
$.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.buyerIdentityHiddenboolean 否True when the authenticated viewer cannot see the buyer during the current response race.
$.oneOf[0].allOf[1].Payload.buyerIdentityHiddenUntilinteger | 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].RequestUserAliasstring 是的
$.oneOf[1].RequestPathstring | null 是的
$.oneOf[1].RequestStatus = "Failed" 是的
$.oneOf[1].ResponseCodeinteger 是的
$.oneOf[1].ResponseMessageAPIResponseMessage 是的
$.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].RequestImpersonatedByUserAliasstring 否
响应示例 
{
    "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://cn.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].RequestUserAliasstring 是的
$.oneOf[0].allOf[0].RequestPathstring | null 是的
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" 是的
$.oneOf[0].allOf[0].ResponseCodeinteger 是的
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 是的
$.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].RequestImpersonatedByUserAliasstring 否
$.oneOf[0].allOf[1]object 是的
$.oneOf[0].allOf[1].Payloadobject 是的
$.oneOf[0].allOf[1].Payload.checkoutURLstring 是的
$.oneOf[0].allOf[1].Payload.amountCentsinteger 是的
$.oneOf[0].allOf[1].Payload.expiresAtinteger 是的
$.oneOf[1]object 是的
$.oneOf[1].RequestUserAliasstring 是的
$.oneOf[1].RequestPathstring | null 是的
$.oneOf[1].RequestStatus = "Failed" 是的
$.oneOf[1].ResponseCodeinteger 是的
$.oneOf[1].ResponseMessageAPIResponseMessage 是的
$.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].RequestImpersonatedByUserAliasstring 否
响应示例 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bidauction/set_checkout",
    "RequestUserAlias": "example-user",
    "Payload": {
        "checkoutURL": "synthetic-example",
        "amountCents": 0,
        "expiresAt": 0
    }
}
机器可读的端点文档