get_locates
Retrieve locate requests for your account, filtered by status, symbol, or date range, sorted by creation date descending.
Instructions
Returns locate requests for the account, filtered by status, symbol, or date range. Results are sorted by creation date descending.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | Filter locates with locate trading date before this date (exclusive). Format: YYYY-MM-DD. The locate trading date uses America/New_York and rolls at 8pm ET. | |
| limit | No | Maximum number of results to return. | |
| start | No | Filter locates with locate trading date on or after this date. Format: YYYY-MM-DD. The locate trading date uses America/New_York and rolls at 8pm ET. | |
| status | No | Locate status. | |
| symbol | No | Filter by stock symbol. | |
| page_token | No | Used for pagination, this token retrieves the next page of results. It is obtained from the response of the preceding page when additional pages are available. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||