Get Available Claim for Token

Get Available Claim for Token.

GET /api/v4/broker/prediction/claims/available/{token_id}

Get Available Claim for Token

cURL

curl --request GET \
  --url https://api.dexbuilder.com/api/v4/broker/prediction/claims/available/{token_id} \
  --header 'KEY: <api-key>' \
  --header 'SIGN: <sign>' \
  --header 'Timestamp: <timestamp>' \
  --header 'X-User-Wallet-Address: <x-user-wallet-address>'

200

{
  "claimable_amount": "<string>",
  "event_id": "<string>",
  "position_count": 123
}

Returns claimable information for one token.

Base URL: https://api.dexbuilder.com

Authentication: Use a Broker API Key and sign this request with Timestamp and SIGN. Pass a wallet address that belongs to your Broker in X-User-Wallet-Address. Calculate the signature using the external Broker path. See Broker API Key and signing and Access on behalf of a user.

​

Request

curl -X GET "https://api.dexbuilder.com/api/v4/broker/prediction/claims/available/{token_id}" \
  -H "KEY: ${BROKER_API_KEY}" \
  -H "SIGN: ${SIGN}" \
  -H "Timestamp: ${TIMESTAMP}" \
  -H "X-User-Wallet-Address: ${USER_WALLET}"

token_id identifies the token.

The OpenAPI panel below is the source of truth for required parameters, types, enum values, and request-body fields. Timestamps are Unix timestamps unless the field description states otherwise.

​

Response

Returns the event ID, claimable amount, and position count.

A successful response uses HTTP 200. Invalid parameters or request bodies return HTTP 400. Private endpoints can return HTTP 401 when authentication fails, and temporary upstream failures can return HTTP 503. The error response contains a machine-readable label and message.

For order, position, claim, transfer, and account operations, treat the response as the current server result and query the resource again when the operation is asynchronous.

Authorizations

KEY · string · header · required

Broker API Key, created through the project administrator's process.

Headers

Timestamp · string · required

Unix timestamp in seconds; the gateway allows at most 60 seconds of clock skew.

SIGN · string · required

Hexadecimal HMAC-SHA512 signature over the external request path, query string, and body.

X-User-Wallet-Address · string · required

End-user wallet address. The gateway checks that this wallet belongs to the current Broker.

Path Parameters

token_id · string · required

Response

200

application/json

Request succeeded

Response object.

claimable_amount · string

event_id · string

position_count · integer