API Reference

V1

Locates

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Locate Rate

LocateGetLocateRateByIdResponse v1().locates().getLocateRateById(LocateGetLocateRateByIdParamsparams = LocateGetLocateRateByIdParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

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

LocateGetLocateRateByIdParams params

Optional<String> instrumentId

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

minLength1

ReturnsExpand Collapse

class LocateGetLocateRateByIdResponse:

LocateRate data

A locate borrow rate for an instrument.

String instrumentId

Instrument id the rate applies to.

formatuuid

String rate

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

Optional<LocalDateTime> asOf

When the rate was requested from the locates venue.

formatdate-time

Get Locate Rate

Java

HTTP

TypeScript

Python

Java

Go

CLI Tool

package com.clearstreet.api.example;

import com.clearstreet.api.client.ClearStreetClient;
import com.clearstreet.api.client.okhttp.ClearStreetOkHttpClient;
import com.clearstreet.api.models.v1.locates.LocateGetLocateRateByIdParams;
import com.clearstreet.api.models.v1.locates.LocateGetLocateRateByIdResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        ClearStreetClient client = ClearStreetOkHttpClient.builder()
            .fromEnv()
            .apiKey("My API Key")
            .build();

        LocateGetLocateRateByIdResponse response = client.v1().locates().getLocateRateById("x");
    }
}

200 example

{
  "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

200 example

{
  "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"
  }
}