Skip to content

Get an order

GET /v1/orders/{id}

Return the current state of an order created by the deposits endpoint. Orders start in the relaying state and settle to confirmed or failed; a confirmed deposit always implies the position's cost basis has been recorded. While an order is in flight the live relay status is consulted, and the execution transaction hash appears as soon as it is known.

Authentication

Send your API key in the api-key header.

Parameters

Name In Type Required Description
id path string yes The order id returned by the deposits endpoint.

Responses

Status Description
200 The order with its current status.
404 No order exists with this id (RESOURCE_001).
500 Storage failure (SYSTEM_001).
200 response
{
  "success": true,
  "data": {
    "orderId": "6884f13ea9b1d43e2c7a9f2b",
    "status": "confirmed",
    "kind": "deposit",
    "chain": 84532,
    "asset": "0x81ab7e0d570b01411fcefcbbcd7de70890a5dd15",
    "amount": "25000000",
    "venueId": "mockvault-84532",
    "photonTxId": "6884f13f539a3c9d28bbca33",
    "executionTxHash": "0x9e8d7c6b5a4f3e2d1c0b9a8f7e6d5c4b3a2f1e0d9c8b7a6f5e4d3c2b1a0f9e8d"
  },
  "timestamp": "2026-07-29T10:16:12.902Z"
}
404 response
{
  "success": false,
  "error": {
    "code": "RESOURCE_001",
    "message": "Requested resource not found",
    "category": "RESOURCE",
    "traceId": "a1b2c3d4e5f60718"
  },
  "timestamp": "2026-07-29T10:15:32.123Z"
}
500 response
{
  "success": false,
  "error": {
    "code": "SYSTEM_001",
    "message": "Database operation failed",
    "category": "SYSTEM",
    "traceId": "a1b2c3d4e5f60718"
  },
  "timestamp": "2026-07-29T10:15:32.123Z"
}