Create Locate

Creates a locate request for a short sale. This endpoint is not available in paper trading.

Idempotency: Reusing the same key with the same request returns the original
locate response. Reusing the same key with a different request returns HTTP 422.

Body Params

Locate request details.

Request to locate shares for a short sale.

boolean
Defaults to false

Reject the locate unless the full requested quantity is available.

string | null

Maximum acceptable locate fee per share, as a decimal string in USD.
If omitted, any quoted fee is accepted.

int64
required
≥ 1

Number of shares to locate. Must be positive and in round lots of 100; invalid quantities return HTTP 400.

string
required

Stock symbol.

Headers
string
length ≤ 128

Optional client-generated key for safe retries and duplicate request detection.
This endpoint currently accepts keys up to 128 characters. Alpaca is moving toward
a 36-character maximum; new implementations should generate a unique UUIDv7 or
UUIDv4 value (36 characters including hyphens) for each logical operation. Do not
reuse a key across operations.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json