## Get Locate

`$ clst v1:locates get-locate-by-id`

**get** `/v1/accounts/{account_id}/locates/{id}`

Fetch one locate by id, matched against the locate request id, locate id,
and client request id, across all days in force.

### Parameters

- `--account-id: number`

  Account identifier

- `--id: string`

  Locate request id, locate id, or client request id

### Returns

- `V1LocateGetLocateByIDResponse: BaseResponse`

  - `data: object { account_id, client_request_id, effective_date, 9 more }`

    A locate request joined with the locate granted for it, if any.

    - `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-locate-by-id \
  --api-key 'My API Key' \
  --account-id 0 \
  --id id
```

#### 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
  }
}
```