bidauction API 참조 | 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://kr.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://kr.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://kr.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
    }
}

기계가 읽을 수 있는 엔드포인트 문서