Overview

This documentation provides information on the Vinter API, covering setup, usage, and understanding of features and endpoints. The content is divided into sections for ease of navigation.

The documentation includes:

1. API endpoints

2. Authentication methods

3. Error handling

4. Best practices

Code snippets and examples are provided to assist in integration.

For additional support or inquiries, contact your designated support agent.

Important Information

Vinter reference rates and index values are published between 0 and 5 minutes after the calculation of the index/reference rate.

When you query all Vinter endpoints without and parameters you receive the latest calculated price available at that point in time. This means that if you query the endpoint right after the calculation time you may receive the previous day's index/reference value.

For this reason, it is important to check the timestamp or created_at value to validate the date after fetching data from the API.

API Changes

The API may undergo incremental changes and any code consuming this API should be developed to accept:

• The addition of new API endpoints

• The addition of optional parameters to existing API requests

• The addition of fields to existing API responses

Index structure

There are indexes containing one or multiple constituents. These two categories are:

• single assets

• multi assets

Single asset indexes track the value of a single asset e.g. BTC in USD, whereas multi assets indexes track the value of a portfolio with multiple assets e.g. BTC and XAU. The indexes are offered in three frequencies:

• real-time (r)

• hourly (h)

• daily (d)

The last letter of the index name indicates its frequency. The btc-usd-p-h index is a single asset index with hourly (h) frequency. The vnby-bold1-d index is a multi asset index with daily (d) frequency.

Historical values

For the daily index series Vinter provides historical time-series. Values prior to the official start date of the index are only approximate values and should not be used for critical analysis. Historical values has a source_id of 0. This makes it easy to separate them from the official values.

API functionality

The core functionality of the Vinter API is to

1. get symbols for all active index values.

2. get current index values and metadata for each index.

By default, the API returns the most recent index value. You can control the number of records returned with the limit parameter. The API returns a maximum of 2000 records. If you are interested in the full history please contact [e-mail]

Try the API

You can use curl to try out the single assets hourly API

curl -H "Authorization: your_secret_api_key" https://www.vinterapi.com/api/v3/single_assets_hourly/?symbol=btc-usd-p-h 

In Python you can do this using the request library:

import requests 
url = "https://www.vinterapi.com/api/v3/single_assets_hourly/?symbol=btc-usd-p-h" 
headers = {"Authorization": your_secret_api_key} 
r = requests.get(url, headers=headers) 

Request API key

The active endpoint can be accessed without an API key, all other endpoints require an API key. You can request an API key by sending an email to [e-mail]