Skip to main content
GET
/
assets
/
list
List all assets with optional filtering
curl --request GET \
  --url https://service.bluumfinance.com/v1/assets/list \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "id": "b0b6dd9d-8b9b-48b9-bbb8-bbbb49bb1bbb",
    "class": "us_equity",
    "market": "NASDAQ",
    "symbol": "AAPL",
    "name": "Apple Inc.",
    "status": "active",
    "tradable": true,
    "marginable": true,
    "shortable": true,
    "easy_to_borrow": true,
    "fractionable": true,
    "currency": "USD"
  },
  {
    "id": "d2d8ff1f-ad1d-6ad1-ddd0-dddd6bdd3ddd",
    "class": "us_equity",
    "market": "NASDAQ",
    "symbol": "MSFT",
    "name": "Microsoft Corporation",
    "status": "active",
    "tradable": true,
    "marginable": true,
    "shortable": true,
    "easy_to_borrow": true,
    "fractionable": true,
    "currency": "USD"
  },
  {
    "id": "e3e9gg2g-be2e-7be2-eee1-eeee7cee4eee",
    "class": "us_equity",
    "market": "NYSE",
    "symbol": "GOOGL",
    "name": "Alphabet Inc. Class A",
    "status": "active",
    "tradable": true,
    "marginable": true,
    "shortable": true,
    "easy_to_borrow": true,
    "fractionable": true,
    "currency": "USD"
  }
]

Authorizations

​
Authorization
string
header
required

HTTP Basic Authentication using the API Key as username and API Secret as password.

Query Parameters

​
status
enum<string>
default:active

Filter by asset status. Defaults to 'active'.

Available options:
active,
inactive
​
asset_class
enum<string>

Filter by asset class.

Available options:
us_equity,
crypto,
us_option
​
tradable
boolean

Filter for assets that are currently tradable.

Response

List of assets

​
id
string
required

Unique identifier for the asset

Example:

"b0b6dd9d-8b9b-48b9-bbb8-bbbb49bb1bbb"

​
class
enum<string>
required

Asset class:

  • us_equity: US stocks
  • crypto: Cryptocurrencies
  • us_option: US options
  • ng_equity: Nigerian stocks (XNSA)
  • ng_bond: Nigerian bonds (XNSA)
  • ng_etf: Nigerian ETFs (XNSA)
Available options:
us_equity,
crypto,
us_option,
ng_equity,
ng_bond,
ng_etf
Example:

"us_equity"

​
market
string
required

Market/exchange code (ISO 10383 MIC):

  • XNAS: NASDAQ
  • XNYS: NYSE
  • BATS: BATS Global Markets
  • ARCA: NYSE Arca
  • OTC: OTC Markets
  • XNSA: Nigerian Stock Exchange
Example:

"XNAS"

​
symbol
string
required

Asset ticker symbol

Example:

"AAPL"

​
name
string
required

Full name of the asset

Example:

"Apple Inc."

​
status
enum<string>
required

Asset status

Available options:
active,
inactive
Example:

"active"

​
tradable
boolean
required

Whether the asset is currently tradable

Example:

true

​
marginable
boolean
required

Whether the asset can be traded on margin

Example:

true

​
shortable
boolean
required

Whether the asset can be shorted

Example:

true

​
easy_to_borrow
boolean
required

Whether the asset is easy to borrow for shorting

Example:

true

​
fractionable
boolean
required

Whether the asset can be traded in fractional shares

Example:

true

​
currency
string
required

Currency code for asset pricing (ISO 4217)

Example:

"USD"

​
price
number

Current/last traded price (optional, when available)

Example:

178.5

​
change
number

Price change from previous close (optional)

Example:

1.5

​
changePercent
number

Percentage change from previous close (optional)

Example:

0.85

​
previousClose
number

Previous day's closing price (optional)

Example:

177

​
bidPrice
number

Current best bid price (optional)

Example:

178.48

​
askPrice
number

Current best ask price (optional)

Example:

178.52