---
title: "Search deposits"
method: POST
path: "/exchanges/{ExchangeCode}/accounts/{AccountIdentifier}/action/search-deposits"
tags: ["Exchange"]
---

# Search deposits

`POST /exchanges/{ExchangeCode}/accounts/{AccountIdentifier}/action/search-deposits`

## Request

- Base URL: `https://sandbox.preprod.connect.xpansiv.com/app/api/v1`
- URL: `https://sandbox.preprod.connect.xpansiv.com/app/api/v1/exchanges/{ExchangeCode}/accounts/{AccountIdentifier}/action/search-deposits`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/xpansiv/apis/xpansiv-connect-api/docs/exchanges/:ExchangeCode/accounts/:AccountIdentifier/action/search-deposits/post.ts> (a function with typed inputs; its response is checked against the schema)

Get list of deposits for an exchange

## Response `200`

List of deposits

- object[]
  - `depositIdentifier` string, required: Unique identifier.
  - `executionVenue` object, required
    - `code` string, required: Ref.Data.EXECUTION_VENUE
    - `name` string, required: Target execution venue code name.
  - `depositMarket` object
    - `market` object, required
      - `name` string, required: Name of the target market on the execution venue.
      - `apiCode` string, required: AIP code sent to the execution venue.
    - `marketModelInstrument` object, required
      - `description` string, required: Description of the Market Model Instrument for the deposit.
      - `price` object, required
        - `amount` number, double, required: Price, if applicable, for the deposit.
  - `taxLot` object, required
    - `name` string, required: The name of the TaxLot associated with the deposit.
  - `instrument` object, required
    - `ein` string, required: The EIN code for the deposit.
    - `description` string, required: The Xpansiv Connect description for the EIN on the deposit.
    - `type` string: REC or CARBON. Ref.Data.INSTRUMENT_TYPE
    - `program` string, required: Ref.Data.PROGRAM
    - `vintage` Vintage, required
      - `year` integer, required: Vintage year.
      - `month` integer: Vintage month.
    - `resource` object, required
      - `name` string, required: The registry name of the item on deposit.
      - `registryAssignedId` string: The registry assigned id for the item on deposit.
  - `quantity` integer, required: The original quantity of the deposit.
  - `availableQuantity` integer, required: The remaining quantity of the deposit.
  - `settledQuantity` integer, required: The quantity of the deposit settled as a result of trading activity.
  - `status` string, required: The current status of the deposit in relation to the execution venue. Ref.Data.DEPOSIT_STATUS

## Other responses

- `400`: Bad request
- `401`: Not authorized error
- `404`: Not found
- `500`: Internal server error

---

[API](https://skmtc.dev/xpansiv/apis/xpansiv-connect-api.md) - [All operations](https://skmtc.dev/xpansiv/apis/xpansiv-connect-api/llms.txt) - [OpenAPI document](https://skmtc.dev/xpansiv/apis/xpansiv-connect-api/revisions/01c1f2c4ec1e?raw)