مرجع API لـ bidauction | 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://ar.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://ar.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://ar.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
    }
}

توثيق نقطة النهاية القابل للقراءة آليًا