CLclear-street
Locates

Get Locate

Changed on

Fetch one locate by id, matched against the locate request id, locate id, and client request id, across all days in force.

get/v1/accounts/{account_id}/locates/{id}

Request

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

Path parameters

account_idinteger required

Account identifier

idstring required

Locate request id, locate id, or client request id

Response

The locate

Example response

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

Changes