Create Claim - DexBuilder Docs

POST

api

broker

prediction

claims

Create Claim

curl --request POST \
  --url https://api.dexbuilder.com/api/v4/broker/prediction/claims \
  --header 'Content-Type: application/json' \
  --header 'KEY: <api-key>' \
  --header 'SIGN: <sign>' \
  --header 'Timestamp: <timestamp>' \
  --header 'X-User-Wallet-Address: <x-user-wallet-address>' \
  --data '
{
  "event_id": "<string>"
}
'

import requests

url = "https://api.dexbuilder.com/api/v4/broker/prediction/claims"

payload = { "event_id": "<string>" }
headers = {
    "Timestamp": "<timestamp>",
    "SIGN": "<sign>",
    "X-User-Wallet-Address": "<x-user-wallet-address>",
    "KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "record_id": "<string>",
  "status": "<string>",
  "total_count": 123
}

{
  "label": "INVALID_ARGUMENT",
  "message": "invalid request"
}

{
  "label": "INVALID_ARGUMENT",
  "message": "invalid request"
}

{
  "label": "INVALID_ARGUMENT",
  "message": "invalid request"
}

Creates a claim request for eligible settled positions. 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 POST "https://api.dexbuilder.com/api/v4/broker/prediction/claims" \
  -H "KEY: ${BROKER_API_KEY}" \
  -H "SIGN: ${SIGN}" \
  -H "Timestamp: ${TIMESTAMP}" \
  -H "X-User-Wallet-Address: ${USER_WALLET}" \
  -H "Content-Type: application/json" \
  -d '<request-body>'

The request body follows the OpenAPI schema. Only eligible settled positions can be claimed. 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 a claim record with record ID, status, counts, and processing timestamps. 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.

Body

application/json

event_id

string

Response

Request succeeded

Response object.

record_id

string

status

string

total_count

integer

Create Claim

curl --request POST \
  --url https://api.dexbuilder.com/api/v4/broker/prediction/claims \
  --header 'Content-Type: application/json' \
  --header 'KEY: <api-key>' \
  --header 'SIGN: <sign>' \
  --header 'Timestamp: <timestamp>' \
  --header 'X-User-Wallet-Address: <x-user-wallet-address>' \
  --data '
{
  "event_id": "<string>"
}
'

import requests

url = "https://api.dexbuilder.com/api/v4/broker/prediction/claims"

payload = { "event_id": "<string>" }
headers = {
    "Timestamp": "<timestamp>",
    "SIGN": "<sign>",
    "X-User-Wallet-Address": "<x-user-wallet-address>",
    "KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "record_id": "<string>",
  "status": "<string>",
  "total_count": 123
}

{
  "label": "INVALID_ARGUMENT",
  "message": "invalid request"
}

{
  "label": "INVALID_ARGUMENT",
  "message": "invalid request"
}

{
  "label": "INVALID_ARGUMENT",
  "message": "invalid request"
}

​Request

​Response

Authorizations

Headers

Body

Response

Request

Response