Read an order by hash
/order/v1/orders/by-hash/{hash}Required token scope: orders:read.
Read an order belonging to the authenticated wallet. Use the signed hash when the placement reply was lost. A response can contain a compact order state, or an enriched view with order, markets and state_freshness. Check pending_operation; HTTP 200 can still describe a pending or unknown outcome. Where order is present, check order.is_terminal to distinguish a completed partial FAK from a working partial order.
Recent activity can appear in account events before reads. A temporary ORDER_NOT_FOUND does not disprove an uncertain placement; retry unavailable reads without discarding confirmed fills. The as_of time is not a completeness watermark. See responses, events and reads.
Authorization
bearerAuth Use an agt_ API token with the scope listed on the operation, or a supported browser access token. HTTP authentication is separate from the EIP-712 order signature.
In: header
Path Parameters
Full 0x-prefixed EIP-712 signed order hash.
^0x[0-9a-fA-F]{64}$Response Body
application/json
application/json
application/json
application/json
application/json
application/problem+json
application/json
curl -X GET "https://example.com/order/v1/orders/by-hash/string"{ "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe", "source": "AGARA", "status": "string", "pending_operation": "SUBMIT", "as_of": "2019-08-24T14:15:22Z", "engine_reference": "string", "remaining_engine_size": "string", "code": "string", "message": "string", "order": { "internal_id": "c13c6907-8dc3-4479-a9ee-0b258d87c410", "exchange": "AGARA", "token_id": "string", "condition_id": "string", "side": "BUY", "type": "string", "price_micro": "string", "original_size_micro": "string", "collateral_amount_micro": "string", "size_matched_micro": "string", "avg_fill_price_micro": "string", "status": "string", "is_terminal": true, "failure": { "code": "string", "title": "string", "detail": "string", "recovery": { "strategy": "string" } }, "expiration": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "cancel_requested_at": "2019-08-24T14:15:22Z" }, "markets": { "property1": { "market_id": "6364d859-8e1b-477a-bacc-de8305a9292b", "market_title": "string", "outcome_name": "string", "logo_url": "string", "event_slug": "string", "state": "string", "neg_risk_id": "string", "display": { "market": {}, "outcome": {} } }, "property2": { "market_id": "6364d859-8e1b-477a-bacc-de8305a9292b", "market_title": "string", "outcome_name": "string", "logo_url": "string", "event_slug": "string", "state": "string", "neg_risk_id": "string", "display": { "market": {}, "outcome": {} } } }, "state_freshness": "LOCAL"}Cancel an order by id DELETE
Required token scope: orders:cancel. Cancel the unfilled remainder of this order. No new order signature or request body is required. Completed fills remain valid. Retry an uncertain cancellation using the same order_id. After ORDER_NOT_OPEN or NOT_FOUND, read the final order state. For PLACE_PENDING or PLACE_OUTCOME_UNKNOWN, resolve the original placement before retrying cancellation. See [cancellation strategies](/best-practices/order-management#cancellation-strategies).
Read an order by id GET
Required token scope: orders:read. Read an order belonging to the authenticated wallet. A response can contain a compact order state, or an enriched view with order, markets and state_freshness. Check pending_operation; HTTP 200 can still describe a pending or unknown outcome. Where order is present, check order.is_terminal to distinguish a completed partial FAK from a working partial order. Recent activity can appear in account events before reads. A temporary ORDER_NOT_FOUND does not disprove an uncertain placement; retry unavailable reads without discarding confirmed fills. The as_of time is not a completeness watermark. See [responses, events and reads](/best-practices/order-management#responses-events-and-reads).