Browse the series catalog

Request

Paged, filtered, searchable series metadata, grouped as identity, classification and the asset / geographic / investor dimensions.

An unrecognised filter is a 400, not a silent no-op.

Security

HTTPBearer or ApiKeyAuth

Query

qstring or null(Q)

Any of:

Free-text search over name, description and identifiers

string

dataset_idstring or null(Dataset Id)

Any of:

e.g. POS.BR.FI.V1

string

model_idstring or null(Model Id)

Any of:

e.g. CFTC

string

productstring or null(Product)

Any of:

string

domainstring or null(Domain)

Any of:

string

universestring or null(Universe)

Any of:

string

asset_typestring or null(Asset Type)

Any of:

EQ, FX, FI, COM

string

asset_subtypestring or null(Asset Subtype)

Any of:

string

benchmark_codestring or null(Benchmark Code)

Any of:

string

geographystring or null(Geography)

Any of:

string

regionstring or null(Region)

Any of:

string

countrystring or null(Country)

Any of:

string

dm_emstring or null(Dm Em)

Any of:

DM or EM

string

investor_categorystring or null(Investor Category)

Any of:

string

investor_typestring or null(Investor Type)

Any of:

string

investor_originstring or null(Investor Origin)

Any of:

string

investor_subtypestring or null(Investor Subtype)

Any of:

string

sectorstring or null(Sector)

Any of:

string

frequencystring or null(Frequency)

Any of:

string

metricstring or null(Metric)

Any of:

string

versionstring or null(Version)

Any of:

Model version, e.g. "V1"

string

records_per_pageinteger, [ 1 .. 1000 ](Records Per Page)

Records per page

Default:100

page_numberinteger, >= 1(Page Number)

Page number, 1-indexed

Default:1

curl -i -X GET \
  'https://docs.vanda-analytics.com/_mock/apis/positioning/vanda-msvc-positioning/positioning/catalog?q=string&dataset_id=string&model_id=string&product=string&domain=string&universe=string&asset_type=string&asset_subtype=string&benchmark_code=string&geography=string&region=string&country=string&dm_em=string&investor_category=string&investor_type=string&investor_origin=string&investor_subtype=string&sector=string&frequency=string&metric=string&version=string&records_per_page=100&page_number=1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json

dataArray of objects(Data)required

Catalog entries

countinteger(Count)required

Entries on this page

paginationobject(PaginationMeta)required

Pagination metadata

Response

{
  "data": [
    {
      "identity": {
        "series_id": 0,
        "series_label": "string",
        "version": "string",
        "dataset_id": "string",
        "model_id": "string",
        "entity": "string",
        "legacy_series_id": "string",
        "aliases": [
          "string"
        ],
        "name": "string",
        "description": "string",
        "start_date": "2019-08-24",
        "frequency": "string",
        "lag": 0,
        "update_time": "string"
      },
      "classification": {
        "product": "string",
        "domain": "string",
        "universe": "string",
        "dataset": "string",
        "model": "string"
      },
      "asset": {
        "asset_type": "string",
        "asset_subtype": "string",
        "asset_code": "string",
        "benchmark": "string",
        "benchmark_code": "string"
      },
      "geographic": {
        "geography": "string",
        "region": "string",
        "country": "string",
        "country_code": "string",
        "dm_em": "string"
      },
      "investor": {
        "investor_category": "string",
        "investor_type": "string",
        "investor_origin": "string",
        "investor_subtype": "string"
      },
      "sector": "string",
      "unit": "string",
      "metric": "string",
      "is_active": true
    }
  ],
  "count": 0,
  "pagination": {
    "page_number": 0,
    "records_per_page": 0,
    "total_record_count": 0,
    "total_pages": 0,
    "has_next": true,
    "has_previous": true
  }
}