Partner API Docs
Partner api

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.

GET
/orders/

Authorization

APIKeyHeader
x-api-key<token>

In: header

Query Parameters

user_account_id?|

Filter to orders belonging to this partner user account.

product?|

Filter to orders placed under this product.

side?|

Filter to orders on this side (buy or sell).

status?|

Filter to orders currently in this lifecycle state.

placed_at_start?|

Lower bound (inclusive) on the order's placed_at timestamp, UTC.

placed_at_end?|

Upper bound (exclusive) on the order's placed_at timestamp, UTC.

per_page?Per Page

Maximum number of orders to return per page.

Default25
Range1 <= value <= 100
last_record_number?Last Record Number

Cursor returned from a previous response; pass to fetch the next page.

Default0
Range0 <= value
sort_order?PartnerOrderListSortOrder

Sort order on placed_at. Defaults to descending (most recent first).

Default"desc"
Value in"asc" | "desc"

Response Body

application/json

application/json

curl -X GET "https://partner-api.cryptofi-dev.com/v1/orders/"
{
  "items": [
    {
      "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"
    }
  ],
  "total_records": 0,
  "last_record_number": 0,
  "per_page": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

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 User Detail

Returns the user-detail payload for the given user account. :param user_account_id: Partner-supplied user identifier (e.g. CIF, member number). :param api_key: Resolved Partner API key, providing the FI scope for the lookup. :return: User-detail response with total market value and the per-product account list. :raises HTTPException: 404 Not Found when no user exists for the given account ID within the partner's FI.