מדריך 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://he.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://he.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://he.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
    }
}

תיעוד נקודת קצה קריא למכונה