Create Locate

Creates a locate request for a short sale.

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 idempotency key for safe retries. Reusing the same key with
the same request returns the original locate response. Reusing the same
key with a different request returns HTTP 422.
We recommend always providing this header in production so timeouts,
network errors, and 5xx responses can be safely retried without creating
duplicate locates. Use a client-generated unique value, such as a UUID,
for each logical locate.

Responses

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