List Locates

Returns locates filtered by status, symbol, or date range. Results are sorted by created_at descending, with id descending as the tie-breaker. This endpoint is not available in paper trading.

Query Params
string

Used for pagination, this token retrieves the next page of results. It is obtained from the response of the preceding page when additional pages are available.

integer
1 to 10000
Defaults to 1000

Maximum number of results to return.

string
enum

Filter by locate status.

Allowed:
string

Filter by stock symbol.

date

Filter locates with locate trading date on or after this date. Format: YYYY-MM-DD. The locate trading date uses America/New_York and rolls at 8pm ET.

date

Filter locates with locate trading date before this date (exclusive). Format: YYYY-MM-DD. The locate trading date uses America/New_York and rolls at 8pm ET.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json