How to use asset identifiers with Atom's API:

Atom's endpoints are designed to be flexible enough to accept multiple types of asset identifiers to accommodate the different data needs of our clients. Accepted identifiers include:

1. atomAssetId
2. A ticker, along with assetType and (sometimes) market
3. isin
4. figi

Using atomAssetId:

atomAssetId is a unique identifier given to every asset available on Atom’s platform. No additional parameters are required when using atomAssetId to identify a desired asset.

Using tickers:

When using tickers, the value field must be all uppercase characters.

All of Atom’s endpoints will accept tickers as identifiers as long as appropriate context is provided to identify the correct asset. (This is because tickers alone aren't unique, and there may be duplicate tickers among markets and asset types.)

For example, the ticker “ETH” is commonly used to identify the cryptocurrency Ethereum. However, it's also used to identify the U.S. stock Ethan Allen Interiors. Therefore, when passing in a ticker as an identifier to an endpoint, you must also pass in an assetType. When the assetType is equal to “Equity” or “Fund”, a market must also be provided. See below for acceptable assetType and market values.

Using FIGIs or ISINs:

FIGI or ISIN values are both industry-standard asset identifiers. Because they're unique to each asset, no additional parameters are required when using a FIGI or ISIN to identify a desired asset.

Examples

enum IdentifierType {
    "ticker",
    "atomAssetId",
    "figi",
    "isin",
}

enum Market {
  "USA",
  "OTC",
  "CAN",
  "BRA",
}

type asset {
    value: string,
    identifier: IdentifierType,
    assetType?: AssetType, // required only with "ticker" identifier
    market?: Market, // required only with "ticker" identifier when assetType = equity or fund
}

// Stock example using ticker
{
    value: "TSLA",
    identifier: "ticker",
    assetType: "equity",
    market: "USA",
}

// Crypto example using ticker
{
    value: "BTC",
    identifier: "ticker",
    assetType: "crypto",
}

// Fund example using ticker
{
    value: "SPY",
    identifier: "ticker",
    assetType: "fund",
    market: "USA",
}

// Example using atomAssetId
{
    value: "e56b20fb-8abd-44f6-a719-9a88f4e13c47",
    identifier: "atomAssetId",
}

// Example using FIGI
{
    value: "BBG294238923",
    identifier: "figi",
}

// Example using ISIN
{
    value: "US0378331005",
    identifier: "isin",
}