Skip to content
Clear Street Clear Street Clear Street
Start Trading
API Reference
V1
Locates

List Locates

client.V1.Locates.GetLocates(ctx, accountID, query) (*V1LocateGetLocatesResponse, error)
GET/v1/accounts/{account_id}/locates

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.

ParametersExpand Collapse
accountID int64
query V1LocateGetLocatesParams
EffectiveDate param.Field[Time]Optional

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

formatdate
InstrumentIDs param.Field[[]InstrumentIDOrSymbol]Optional

Comma-separated instrument IDs (UUID) or symbols.

Status param.Field[[]string]Optional

Comma-separated locate statuses to filter by

const V1LocateGetLocatesParamsStatusRequested V1LocateGetLocatesParamsStatus = "REQUESTED"
const V1LocateGetLocatesParamsStatusAccepted V1LocateGetLocatesParamsStatus = "ACCEPTED"
const V1LocateGetLocatesParamsStatusRejected V1LocateGetLocatesParamsStatus = "REJECTED"
const V1LocateGetLocatesParamsStatusExpired V1LocateGetLocatesParamsStatus = "EXPIRED"
ReturnsExpand Collapse
type V1LocateGetLocatesResponse struct{…}
AccountID int64

Account the locate is booked to.

formatint64
ClientRequestID string

Caller-assigned id of the locate request.

EffectiveDate Time

New York calendar date the locate is in force for.

formatdate
InstrumentID string

Instrument id.

formatuuid
LocateRequestID string

Engine-assigned locate request id.

formatuuid
RequestedQuantity int64

Number of shares requested.

formatint64

Presented status of the locate.

One of the following:
const LocateStatusRequested LocateStatus = "REQUESTED"
const LocateStatusAccepted LocateStatus = "ACCEPTED"
const LocateStatusRejected LocateStatus = "REJECTED"
const LocateStatusExpired LocateStatus = "EXPIRED"
LocateID stringOptional

Engine-assigned locate id; set once the locate is granted. When a null/undefined value is observed, it indicates it does not apply.

formatuuid
Quantity int64Optional

Number of shares granted; set once the locate is granted. When a null/undefined value is observed, it indicates it does not apply.

formatint64

Client order id the request relates to, if any. When a null/undefined value is observed, it indicates it does not apply.

formatuuid
ReservedQuantity int64Optional

Number of granted shares reserved. When a null/undefined value is observed, it indicates it does not apply.

formatint64
UsedQuantity int64Optional

Number of granted shares already used. When a null/undefined value is observed, it indicates it does not apply.

formatint64

List Locates

package main

import (
  "context"
  "fmt"

  "github.com/clear-street/clear-street-go"
  "github.com/clear-street/clear-street-go/option"
)

func main() {
  client := clearstreet.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.V1.Locates.GetLocates(
    context.TODO(),
    0,
    clearstreet.V1LocateGetLocatesParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response)
}

{
  "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": [
    {
      "account_id": 0,
      "client_request_id": "client_request_id",
      "effective_date": "2019-12-27",
      "instrument_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "locate_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "requested_quantity": 0,
      "status": "REQUESTED",
      "locate_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "quantity": 0,
      "related_order_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "reserved_quantity": 0,
      "used_quantity": 0
    }
  ]
}
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": [
    {
      "account_id": 0,
      "client_request_id": "client_request_id",
      "effective_date": "2019-12-27",
      "instrument_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "locate_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "requested_quantity": 0,
      "status": "REQUESTED",
      "locate_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "quantity": 0,
      "related_order_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "reserved_quantity": 0,
      "used_quantity": 0
    }
  ]
}