Skip to main content
GET
List Available Claims
Returns claimable positions available to the authenticated account. 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

Use the supported event, condition, and cursor filters. 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 claim records or claimable position summaries with claimable amount and position counts. 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.

Response

Request succeeded

Response object.

event_count
integer
events
object[]
total_claimable_amount
string