CLclear-street
Locates

List Locates

Changed on

List locates for the account on one effective date, which defaults to today's New York calendar date. Filter by comma-separated statuses and instrument ids or symbols.

get/v1/accounts/{account_id}/locates

Request

  • Base URL
    https://api.clearstreet.com
  • Auth
    HTTP bearer

Path parameters

account_idinteger required

Account identifier

Query parameters

effective_datestring date

Effective date to list; defaults to today's New York calendar date. Explicit dates are used unchanged, including weekends and holidays.

statusstring[]

Comma-separated locate statuses to filter by

instrument_idsInstrumentIdOrSymbol[]

Comma-separated instrument IDs (UUID) or symbols.

Response

List of locates

Example response

{
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero"
  },
  "metadata": {
    "page_number": 1,
    "total_items": 42,
    "total_pages": 5
  }
}

Changes