Skip to main content

Filtering

  • If specified in the API documentation, an endpoint may support filters on specific fields and values e.g. GET /orders?status=OPEN
  • Only fields returned in an API response may be used as filter parameters. What you see is what you query on and by.
  • For the fields in the API response usable as filter parameters, please consult the API endpoint of interest.
  • Datetime and timestamp filters require additional keywords from this list - [ gte, lte, gt, lt ]. A few examples are provided below.
  • /trading-api/v1/trades?createdAtTimestamp[gte]=1686447835000 queries for trades with createdAtTimestamp greater than or equal to 1686447835000.
  • /trading-api/v1/trades?createdAtDatetime[gte]=2023-04-06T00:00:00.000Z&createdAtDatetime[lte]=2023-06-07T00:00:00.000Z queries for trades with createdAtDatetime greater than or equal to 2023-04-06T00:00:00.000Z but less than or equal to 2023-06-07T00:00:00.000Z
  • By design, pagination query parameters start with an underscore. This differentiates them from filter query parameters e.g. GET /orders?status=OPEN&_pageSize=25