bidauction APIリファレンス

すべてのエンドポイントを検索

/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://jp.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://jp.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://jp.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
    }
}

機械可読のエンドポイントドキュメント