Partner API Docs
Partner api

Get Order Detail

Returns the order-detail payload for the given order id. :param order_id: Order identifier (the order's tx_id). :param api_key: Resolved Partner API key, providing the FI scope for the lookup. :return: Order-detail response with the order metadata and lifecycle state. :raises HTTPException: 404 Not Found when no order with that id exists within the partner's FI.

GET
/orders/{order_id}/

Authorization

APIKeyHeader
x-api-key<token>

In: header

Path Parameters

order_id*Order Id

Response Body

application/json

application/json

curl -X GET "https://partner-api.cryptofi-dev.com/v1/orders/string/"
{
  "order_id": "string",
  "user_account_id": "string",
  "product": "crypto",
  "side": "buy",
  "symbol": "string",
  "quantity": "string",
  "notional": "string",
  "fee": "string",
  "status": "pending",
  "placed_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "is_recurring_order": true,
  "recurring_order_id": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Get Health

Public health check endpoint for partner connectivity validation. No authentication required.

Get Order List

Returns a paginated list of orders matching the given filters. :param params: Filter and pagination query parameters. :param api_key: Resolved Partner API key, providing the FI scope for the lookup. :return: Paginated order list with items and pagination metadata.