Cash flows

Also see Cash flows.

Categories

Also see Categories.

Drafts

Also see Drafts.

Favorers

Also see Favorers.

Favorites

Also see Favorites.

Global categories

Also see Global categories.

Group categories

Also see Group categories.

Portfolios

Also see Portfolios.

Previews

Also see Previews.

Also see Search.

Time series

Also see Time series.

Trades

Also see Trades.

Resource representations

{
  "kind": "instrument",
  "id": integer,
  "isin": string,
  "description": string,
  "slug": string,
  "bond_maturity": decimal,
  "capitalized": string,
  "currency_iso": string,
  "price": decimal,
  "euro_price": decimal,
  "lot_size": integer,
  "instrument_type": string,
  "asset_class": string,
  "long_asset_class": string,
  "stock_exchange": string,
  "active": boolean,
  "favorited": boolean,
  "capitalized": boolean,
  "fund_manager": string,
  "management_fee": decimal,
  "yield_to_maturity": decimal,
  "duration": decimal,
  "coupon_rate": decimal,
  "coupon_frequency": integer,
  "expiration_date": date,
  "price_earning": decimal,
  "price_to_book": decimal,
  "dividend_yield": decimal,
  "valuation": decimal,
  "activity_index": decimal,
  "category_id": integer,
  "category": category,
  "group_category_id": integer,
  "group_category": group_category,
  "global_category_id": integer,
  "global_category": global_category,
  "favorer_count": integer,
  "portfolio_count": integer,
  "periods": string[],
  "time_series": time_series[],
  "exante_indicators": {
    "cvar1": decimal,
    "cvar5": decimal,
    "downside_volatility": decimal,
    "maximum_drawdown_1_month": decimal,
    "maximum_drawdown_1_year": decimal,
    "liquidity": decimal,
    "risk": decimal,
    "shortfall_probability": decimal,
    "var1": decimal,
    "var5": decimal,
    "volatility": decimal
  },
  "expost_indicators_1_day": {
    "performance": decimal
  },
  "expost_indicators_1_month": {
    "performance": decimal,
    "maximum_drawdown": decimal,
    "volatility": decimal,
    "downside_volatility": decimal,
    "sharpe_ratio": decimal,
    "sortino_ratio": decimal
  },
  "expost_indicators_1_year": {
    "performance": decimal,
    "maximum_drawdown": decimal,
    "volatility": decimal,
    "downside_volatility": decimal,
    "sharpe_ratio": decimal,
    "sortino_ratio": decimal
  },
  "expost_indicators_all": {
    "performance": decimal,
    "maximum_drawdown": decimal,
    "volatility": decimal,
    "downside_volatility": decimal,
    "sharpe_ratio": decimal,
    "sortino_ratio": decimal
  }
}

Methods


GET /instruments
List all the instruments in the specified collection.

List all the instruments in the specified collection.

Filters

The instrument type filter accepts any combination of the following values

  • bond
  • equity
  • etf
  • fund

Separate multiple criteria for the same filter using the comma character (,).

instrument_type_in=etf,bond

The duration and price earning filters accept range criteria of the following types:

  • Less than x: ‘|x’
  • Between x and y: ‘x|y’
  • More than x: ‘x|’

Separate multiple criteria for the same filter using the comma character (,).

duration_in=|10,50|60,100|

Filters can be combined.

duration_in=4|5&category_id_in=1,3,4,6

Sort

The results can be sorted based on one or more of the following criteria

  • bond_maturity
  • capitalized
  • coupon_rate
  • currency_iso
  • description
  • dividend_yield
  • duration
  • euro_price
  • expiration_date
  • liquidity
  • lot_size
  • management_fee
  • performance_1d
  • performance_1m
  • performance_1y
  • portfolio_count
  • price
  • price_earning
  • price_to_book
  • risk
  • valuation
  • yield_to_maturity

For each criteria an optional order can be specified using the pipe character (|).

sorted_by=liquidity|asc

Separate multiple criteria using the comma character (,).

sorted_by=performance_1m|asc,risk

Params

Param Name Description
instrument_type_in
Optional

Instrument type filters.


Value:

Must be String

category_id_in
Optional

Category filters.


Value:

Must be String

global_category_id_in
Optional

Global category filters.


Value:

Must be String

group_category_id_in
Optional

Group category filters.


Value:

Must be String

duration_in
Optional

Duration filters.


Value:

Must be String

price_earning_in
Optional

Price earning filters.


Value:

Must be String

sorted_by
Optional

Sort order of results.


Value:

Must be String


GET /instruments/:id
Get an instrument.

Get an instrument.

Params

Param Name Description
id
Required

The slug of the instrument to get.


Value:

Must be String