Get Order - DexBuilder Docs

GET

api

broker

prediction

orders

{order_id}

Get Order

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

import requests

url = "https://api.dexbuilder.com/api/v4/broker/prediction/orders/{order_id}"

headers = {
    "Timestamp": "<timestamp>",
    "SIGN": "<sign>",
    "X-User-Wallet-Address": "<x-user-wallet-address>",
    "KEY": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

{
  "client_order_id": "<string>",
  "condition_id": "<string>",
  "created_at": 123,
  "error_code": "<string>",
  "event_id": "<string>",
  "expire_time": 123,
  "order_id": "<string>",
  "order_mode": "LIMIT",
  "order_type": "GTC",
  "outcome": "<string>",
  "price": "<string>",
  "side": "<string>",
  "size": "<string>",
  "size_left": "<string>",
  "size_matched": "<string>",
  "status": "processing",
  "token_id": "<string>",
  "updated_at": 123
}

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

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

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

Returns one authenticated order. 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/orders/{order_id}" \
  -H "KEY: ${BROKER_API_KEY}" \
  -H "SIGN: ${SIGN}" \
  -H "Timestamp: ${TIMESTAMP}" \
  -H "X-User-Wallet-Address: ${USER_WALLET}"

order_id identifies the order. 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 order’s identifiers, side, order mode/type, price, original/fill/remaining quantities, status, error information, and 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.

Path Parameters

order_id

string

required

Response

Request succeeded

Response object.

client_order_id

string

condition_id

string

created_at

integer

error_code

string

event_id

string

expire_time

integer

order_id

string

order_mode

enum<string>

Execution mode: LIMIT or MARKET

Available options:

LIMIT,

MARKET

order_type

enum<string>

Time-in-force: GTC, GTD, FOK, or FAK

Available options:

GTC,

GTD,

FOK,

FAK

outcome

string

price

string

side

string

size

string

size_left

string

size_matched

string

status

enum<string>

Lowercase REST order status

Available options:

processing,

open,

matched,

canceled,

failed

token_id

string

updated_at

integer

Get Order

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

import requests

url = "https://api.dexbuilder.com/api/v4/broker/prediction/orders/{order_id}"

headers = {
    "Timestamp": "<timestamp>",
    "SIGN": "<sign>",
    "X-User-Wallet-Address": "<x-user-wallet-address>",
    "KEY": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

{
  "client_order_id": "<string>",
  "condition_id": "<string>",
  "created_at": 123,
  "error_code": "<string>",
  "event_id": "<string>",
  "expire_time": 123,
  "order_id": "<string>",
  "order_mode": "LIMIT",
  "order_type": "GTC",
  "outcome": "<string>",
  "price": "<string>",
  "side": "<string>",
  "size": "<string>",
  "size_left": "<string>",
  "size_matched": "<string>",
  "status": "processing",
  "token_id": "<string>",
  "updated_at": 123
}

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

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

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

​Request

​Response

Authorizations

Headers

Path Parameters

Response

Request

Response