ALalpacahq
ACATS

List assets for a transfer

Assets are only available for partial transfers and for transfers where the deliverer has already responded with the list of assets. The asset list may change as the transfer is updated by the deliverer, all the way up until the transfer settles.

get/v1beta1/acats/{account_id}/{acats_id}/assets

Request

  • Base URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets
  • URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets/v1beta1/acats/{account_id}/{acats_id}/assets
  • Auth
    HTTP basic

Path parameters

account_idstring uuid required

Account ID associated with the ACATS transfer

acats_idstring uuid required

The ID of the ACATS transfer

Response

OK

amountstring decimal

Positive number indicating the market value of the assets being transferred

asset_class'EQUITY' | 'CASH' | 'OPTION' | 'OTHER' required

Asset type

asset_descriptionstring required

Description, usually from DTCC's Security Master File

currency_codestring

ISO currency code in which amount is denominated

cusipstring

CUSIP security identifier for the asset. Only returned when a CUSIP was provided for this asset at the time the transfer was initiated, in which case it is returned alongside symbol.

isinstring

Deprecation notice: Use symbol or cusip instead. Returned with all assets only for backward compatibility while consumers migrate.

Since: 2026-08-04 Sunset: 2027-02-04

ISIN for the asset.

position'LONG' | 'SHORT' | 'CREDIT' | 'DEBIT' required

Position type. LONG and SHORT apply to security positions; CREDIT and DEBIT apply to cash positions.

qtystring decimal

Positive number indicating how many shares or units are being transferred

rejection_messagestring

Human readable reason for why an asset is considered ineligible for transfer

status'NOT_VALIDATED' | 'REQUESTED' | 'DELETED' | 'SETTLED' | 'REVERSED' | 'INTERFACE_REJECTED' required

Status

symbolstring

Symbol identifier for the asset. Always returned when a symbol is known for the asset, including when the transfer was initiated with a CUSIP.

Example response

[
  {
    "asset_class": "EQUITY",
    "asset_description": "APPLE INC",
    "cusip": "037833100",
    "position": "LONG",
    "qty": "10",
    "status": "SETTLED",
    "symbol": "AAPL"
  },
  {
    "amount": "1250.75",
    "asset_class": "CASH",
    "asset_description": "US DOLLAR",
    "currency_code": "USD",
    "position": "CREDIT",
    "status": "SETTLED"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.