Institution metrics

Returns metrics for specified institutions. Results are ordered by tuple (institution, time). To fetch the next page of results use next_page_url JSON response field.

get

https://api.coinmetrics.io/v4https://community-api.coinmetrics.io/v4

/timeseries/institution-metrics

Authorizations

api_key

api_keystringRequired

Coin Metrics API key can be specified as ?api_key= query parameter.

Query parameters

institutionsstring[]Required

Comma separated list of institutions, or wildcard (*) for all supported institutions.
Note: the wildcards are not supported when sort parameter is set to time.
Use the /catalog-all-v2/institution-metrics endpoint for the full list of supported institutions.

metricsstring[]Required

Comma separated metrics to request time series data for.
Information on all available metrics can be found on page https://docs.coinmetrics.io/market-data/market-data-overview/institution-metrics-overview.
Use the /catalog-all-v2/institution-metrics endpoint for the full list of supported metrics per institution.

Example: ["btc_total_assets","btc_shares_outstanding"]

frequencystringOptional

Frequency of the institution metrics. Supported values are 1d.

Default: 1d

start_timestringOptional

Start of the time interval.
This field refers to the time field in the response.
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.123456789Z, 2006-01-20, 20060120.
Inclusive by default.
UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it.
If start_time is omitted, response will include time series from the earliest time available.

end_timestringOptional

End of the time interval.
This field refers to the time field in the response.
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.123456789Z, 2006-01-20, 20060120.
Inclusive by default.
UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it.
If end_time is omitted, response will include time series up to the latest time available.

start_inclusivebooleanOptional

Inclusive or exclusive corresponding start_* parameters.

Default: true

end_inclusivebooleanOptional

Inclusive or exclusive corresponding end_* parameters.

Default: true

timezonestringOptional

Timezone name for start_time and end_time timestamps.
This parameter does not modify the output times, which are always UTC.
Format is defined by TZ database.

Default: UTCExample: America/New_York

page_sizeinteger · int32 · min: 1 · max: 10000Optional

Number of items per single page of results.
The value of this parameter is ignored if the endpoint supports the format parameter and its value is set to json_stream.

Default: 100

paging_fromstring · enumOptional

Where does the first page start, at the start of the interval or at the end.
The value of this parameter is ignored if the endpoint supports the format parameter and its value is set to json_stream.

Default: endPossible values:

sortstring · enumOptional

How results will be sorted. Metrics are sorted by (institution, time) by default. If you want to sort 1d metrics by (time, institution) you should choose time as value for the sort parameter.
Sorting by time is useful if you request metrics for a set of institutions.
Note: sorting by time is not supported when wildcards are used.

Default: institutionPossible values:

limit_per_institutioninteger · int32Optional

How many entries per institution result should contain. For example, this combination of parameters institutions=institution1,institution2&metrics=total_assets&limit_per_institution=1 returns the latest total_assets values for institution1 and institution2.

prettybooleanOptional

Human-readable formatting of JSON responses.

Default: false

formatstring · enumOptional

Format of the response.

Default: jsonPossible values:

next_page_tokenstringOptional

Token for receiving the results from the next page of a query.
Should not be used directly. To iterate through pages just use next_page_url response field.

Responses

200

Time series of institution metrics.

application/json

Time series of institution metrics.

dataanyRequired

next_page_tokenstringOptional

Token of the next page results for a given request.

next_page_urlstringOptional

URL of the next page results for a given request.

400

Market not found.

application/json

401

Requested resource requires authorization.

application/json

403

Requested resource is not available with supplied credentials.

application/json

414

Provided URI is too long. It must not be greater than 10000 symbols.

get/timeseries/institution-metrics

ShellPythonPython Client

curl --compressed "https://api.coinmetrics.io/v4/timeseries/institution-metrics?institutions=grayscale&metrics=btc_total_assets&frequency=1d&pretty=true&api_key=<your_key>"

{
  "data": [
    {
      "institution": "institution1",
      "time": "2020-09-28T00:00:00.000000000Z",
      "total_assets": 317000178.776577
    },
    {
      "institution": "institution1",
      "time": "2020-09-29T00:00:00.000000000Z",
      "total_assets": 246153685.485477
    },
    {
      "institution": "institution1",
      "time": "2020-09-30T00:00:00.000000000Z",
      "total_assets": 217972373.240482
    },
    {
      "institution": "institution1",
      "time": "2020-10-01T00:00:00.000000000Z",
      "total_assets": 492203699.871197
    }
  ]
}