Skip to content

list_products

GET
/v0/products

Authorizations

Parameters

Query Parameters

kind
string

An optional filter to restrict the kind of product by

before
string format: date-time

An optional filter to select products with delivery windows on or before this value

after
string format: date-time

An optional filter to select products with delivery windows on or after this value

Responses

200

Standard response format for product queries.

This structure provides a consistent format for returning product query results, including optional pagination metadata.

object
more

A query for searching for known products

object
after

An optional filter to select products with delivery windows on or after this value

string | null format: date-time
before

An optional filter to select products with delivery windows on or before this value

string | null format: date-time
kind

An optional filter to restrict the kind of product by

string | null
results
required

Collection of product query results

Array

A product record combines a standard product ID with implementation-specific data.

Products are the fundamental tradable entities in the system. The core only defines products by their ID, allowing implementations to attach domain-specific data.

Product records are immutable once defined.

object
from
required

The starting time of the delivery interval for the product

string format: date-time
kind
required

A tag describing the type of product (e.g. “FORWARD” or “OPTION”)

string
thru
required

The stopping time of the delivery interval for the product

string format: date-time
id
required

Unique identifier for the product

string format: uuid

500