ALalpacahq
Assets

Retrieve an Asset by ID

Returns the requested asset, if found

get/v1/assets/{symbol_or_asset_id}

Request

  • Base URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets
  • URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets/v1/assets/{symbol_or_asset_id}
  • Auth
    HTTP basic

Response

Returns asset

attributesstring[]

Unique characteristics of the asset. Supported values:

  • ptp_no_exception: Asset is a Publicly Traded Partnership (PTP) without a qualified notice; non-U.S. customers may incur 10% withholding on gross proceeds as per IRS guidance, and are blocked from being purchased by default.
  • ptp_with_exception: Users can open positions in these PTPs without general restrictions.
  • ipo: Accepting limit orders only before the stock begins trading on the secondary market.
  • has_options: The underlying equity has listed options available on the platform. Note: if the equity had inactive/expired contracts in the past, this will still show up.
  • options_late_close: Indicates the underlying asset's options contracts close at 4:15pm ET instead of the standard 4:00pm ET.
  • fractional_eh_enabled: Indicates the asset accepts fractional orders during extended hours sessions (pre-market, post-market, and overnight if enabled).
  • overnight_tradable: Asset is eligible for overnight (24x5) trading in supported venues on the platform.
  • overnight_halted: Asset is eligible for overnight trading but is currently halted/blocked for overnight sessions due to risk, corporate action, compliance, or venue constraints.
borrow_status'easy_to_borrow' | 'hard_to_borrow'

Borrow status for US equity assets. This field is omitted for non-US-equity assets.

class'us_equity' | 'us_option' | 'us_index' | 'crypto' | 'crypto_perp' | 'ipo' required

This represents the category to which the asset belongs to. It serves to identify the nature of the financial instrument, with options including "us_equity" for U.S. equities, "us_option" for U.S. options, "crypto" for cryptocurrencies, and "ipo" for IPO indications of interest. This asset_class: ipo value is distinct from the assets API attributes: ["ipo"] flag.

exchange'AMEX' | 'ARCA' | 'BATS' | 'NYSE' | 'NASDAQ' | 'NYSEARCA' | 'OTC' | 'TXSE' | 'CRYPTO' | 'ERSX' | 'CRXL' | 'ASCX' | 'INDEX' required

Represents the exchange where an asset is traded.

For Stocks:

  • AMEX
  • ARCA
  • BATS
  • NYSE
  • NASDAQ
  • NYSEARCA
  • OTC
  • TXSE

For Crypto:

  • CRYPTO
  • ERSX
  • CRXL

For crypto perpetuals:

  • ASCX

Index symbols:

  • INDEX

INDEX is the artificial exchange for index symbols such as SPX.

fractionableboolean required

Asset is fractionable or not

idstring uuid required

Asset ID

maintenance_margin_requirementnumber

deprecated: Please use margin_requirement_long or margin_requirement_short instead. Note that these fields are of type string. Shows the margin requirement percentage for the asset (equities only).

margin_requirement_longstring decimal required

The margin requirement percentage for the asset's long positions (equities only), encoded as a decimal string.

margin_requirement_shortstring decimal required

The margin requirement percentage for the asset's short positions (equities only), encoded as a decimal string.

marginableboolean required

Asset is marginable or not

min_order_sizestring

Minimum order size. Field available for crypto only.

min_trade_incrementstring

Amount a trade quantity can be incremented by. Field available for crypto only.

namestring required

The official name of the asset

price_incrementstring

Amount the price can be incremented by. Field available for crypto only.

shortableboolean required

Asset is shortable or not

status'active' | 'inactive' required

active or inactive

symbolstring required

The symbol of the asset

tradableboolean required

Asset is tradable on Alpaca or not

Example response

{
  "attributes": [
    "ptp_no_exception",
    "ipo"
  ],
  "borrow_status": "easy_to_borrow",
  "exchange": "NASDAQ",
  "fractionable": true,
  "id": "904837e3-3b76-47ec-b432-046db621571b",
  "margin_requirement_long": "100",
  "margin_requirement_short": "30",
  "marginable": true,
  "name": "Apple Inc. Common Stock",
  "shortable": true,
  "status": "active",
  "symbol": "AAPL",
  "tradable": true
}

Changes

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