Skip to main content
Returns metrics for specified institutions.
  • Parameters:
    • institutions (list (str ) , str) — A single institution name or a list of institutions to return info for.
    • metrics (list (str ) , str) — list of institution-specific metric names, e.g. ‘gbtc_total_assets’
    • frequency (str) — frequency of the returned timeseries, e.g 15s, 1d, etc.
    • page_size (int) — number of items returned per page when calling the API. If the request times out, try using a smaller number.
    • paging_from (PagingFrom , str) — Defines where you want to start receiving items from, ‘start’ or ‘end’ of the timeseries.
    • start_time (datetime , date , str) — Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
    • end_time (datetime , date , str) — End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
    • start_height (int) — Start block of the timeseries (only applicable when querying with frequency 1b).
    • end_height (int) — End block of the timeseries (only applicable when querying with frequency 1b).
    • start_inclusive (bool) — Flag to define if start timestamp must be included in the timeseries if present. True by default.
    • end_inclusive (bool) — Flag to define if end timestamp must be included in the timeseries if present. True by default.
    • timezone (str) — timezone of the start/end times in db format for example: “America/Chicago”. Default value is “UTC”. For more details check out API documentation page.
    • sort (str) — How results will be sorted, e.g. “institution”, or “time”. Default is “institution”.
    • limit_per_institution (int) — How many entries per institution the result should contain.
    • format (str) — Format of the response. Supported values are json, csv. Default is json.
Returns: