## List Locates

`$ clst v1:locates get-locates`

**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.

### Parameters

- `--account-id: number`

  Account identifier

- `--effective-date: optional string`

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

- `--instrument-id: optional array of InstrumentIDOrSymbol`

  Comma-separated instrument IDs (UUID) or symbols.

- `--status: optional array of "REQUESTED" or "ACCEPTED" or "REJECTED" or "EXPIRED"`

  Comma-separated locate statuses to filter by

### Returns

- `V1LocateGetLocatesResponse: BaseResponse`

  - `data: array of Locate`

    - `account_id: number`

      Account the locate is booked to.

    - `client_request_id: string`

      Caller-assigned id of the locate request.

    - `effective_date: string`

      New York calendar date the locate is in force for.

    - `instrument_id: string`

      Instrument id.

    - `locate_request_id: string`

      Engine-assigned locate request id.

    - `requested_quantity: number`

      Number of shares requested.

    - `status: "REQUESTED" or "ACCEPTED" or "REJECTED" or "EXPIRED"`

      Presented status of the locate.

      - `"REQUESTED"`

      - `"ACCEPTED"`

      - `"REJECTED"`

      - `"EXPIRED"`

    - `locate_id: optional string`

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

    - `quantity: optional number`

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

    - `related_order_id: optional string`

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

    - `reserved_quantity: optional number`

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

    - `used_quantity: optional number`

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

### Example

```cli
clst v1:locates get-locates \
  --api-key 'My API Key' \
  --account-id 0
```

#### Response

```json
{
  "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
    }
  ]
}
```