Skip to main content
GET
/
v1
/
order
/
by-client-id
/
{clientId}
Get Onchain Order by Client ID
curl --request GET \
  --url https://swap-api.flux.fun/v1/order/by-client-id/{clientId} \
  --header 'x-api-key: <api-key>'
{
  "id": "intent_abc123xyz",
  "clientId": "client-order-123",
  "action": {
    "orderType": "MarketOrder",
    "order": {
      "quoteToken": {
        "type": "chain",
        "data": {
          "tokenId": "USDC",
          "chainId": 8453,
          "contractAddress": "0x..."
        }
      },
      "baseToken": {
        "type": "kalshi",
        "data": {
          "marketId": "BTC-100K-2024",
          "side": "yes"
        }
      },
      "orderType": "BUY",
      "baseQuantity": "100",
      "maxQuoteQuantityIn": "50.00"
    },
    "chainId": 8453
  },
  "createdAt": "2024-01-12T10:00:00.000Z",
  "status": "validated",
  "balanceValidatedAt": "2024-01-12T10:00:05.000Z",
  "txnFilledAt": "2024-01-12T10:00:10.000Z",
  "transactionHash": "0xabc123...",
  "isComplete": false,
  "terminationReason": null
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
clientId
string
required

The unique client-provided identifier for the order

Response

Order details

​
id
string
required

Unique order intent ID

Example:

"intent_abc123xyz"

​
clientId
string | null
required

Client-provided order ID

Example:

"client-order-123"

​
action
object
required

Order action details

Example:
{
  "orderType": "MarketOrder",
  "order": {
    "quoteToken": {
      "type": "chain",
      "data": {
        "tokenId": "USDC",
        "chainId": 8453,
        "contractAddress": "0x..."
      }
    },
    "baseToken": {
      "type": "kalshi",
      "data": {
        "marketId": "BTC-100K-2024",
        "side": "yes"
      }
    },
    "orderType": "BUY",
    "baseQuantity": "100",
    "maxQuoteQuantityIn": "50.00"
  },
  "chainId": 8453
}
​
createdAt
string
required

When the order was created

Example:

"2024-01-12T10:00:00.000Z"

​
status
enum<string>
required
Available options:
pending,
executing,
validated,
completed,
failed
Example:

"validated"

​
balanceValidatedAt
string | null
required

When balance was validated

Example:

"2024-01-12T10:00:05.000Z"

​
txnFilledAt
string | null
required

When transaction was filled

Example:

"2024-01-12T10:00:10.000Z"

​
transactionHash
string | null
required

Blockchain transaction hash

Example:

"0xabc123..."

​
isComplete
boolean
required

Whether the order is complete

Example:

false

​
terminationReason
string | null
required

Reason for termination if failed

Example:

null