Get Locate Rate

$ clst v1:locates get-locate-rate-by-id

GET/v1/locates/rates/{instrument_id}

Fetch the cached locate borrow rate for one instrument. Rates refresh periodically; 404 means no rate is currently cached for the instrument.

ParametersExpand Collapse

--instrument-id: string

Instrument identifier: either an instrument UUID or a symbol (symbol for equities, OSI for options). Non-UUID inputs are resolved server-side.

ReturnsExpand Collapse

V1LocateGetLocateRateByIDResponse: BaseResponse { metadata, error }

data: object { instrument_id, rate, as_of }

A locate borrow rate for an instrument.

instrument_id: string

Instrument id the rate applies to.

rate: string

Borrow rate, expressed as a decimal (e.g. 0.037012 for 3.7012%).

as_of: optional string

When the rate was requested from the locates venue.

Get Locate Rate

clst v1:locates get-locate-rate-by-id \
  --api-key 'My API Key' \
  --instrument-id x

{
  "metadata": {
    "request_id": "request_id",
    "next_page_token": "U3RhaW5sZXNzIHJvY2tz",
    "page_number": 1,
    "previous_page_token": "U3RhaW5sZXNzIHJvY2tz",
    "total_items": 42,
    "total_pages": 5
  },
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero",
    "details": [
      {
        "foo": "bar"
      }
    ]
  },
  "data": {
    "instrument_id": "528ec5c3-cdbf-447c-b995-ec6c83cfbc02",
    "rate": "0.037012",
    "as_of": "2026-09-10T14:33:07.107683Z"
  }
}

Returns Examples

{
  "metadata": {
    "request_id": "request_id",
    "next_page_token": "U3RhaW5sZXNzIHJvY2tz",
    "page_number": 1,
    "previous_page_token": "U3RhaW5sZXNzIHJvY2tz",
    "total_items": 42,
    "total_pages": 5
  },
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero",
    "details": [
      {
        "foo": "bar"
      }
    ]
  },
  "data": {
    "instrument_id": "528ec5c3-cdbf-447c-b995-ec6c83cfbc02",
    "rate": "0.037012",
    "as_of": "2026-09-10T14:33:07.107683Z"
  }
}