v0 release: fund profiles, holdings, sectors and countries, crypto prices, ETF metrics, and the same status codes on every route.
Summary
- Search Endpoint: The search endpoint now supports funds, crypto, and forex data.
- Consistent API Response Codes: The API response codes are now consistent across all endpoints:
- 200: Success
- 401: Unauthorised
- 403: Forbidden
- 404: Not Found
- 500: Internal Server Error
- New Endpoints
- Crypto Price: Returns price data for cryptocurrencies.
- ETF Fundamental: Returns fundamental data for Exchange Traded Funds (ETFs).
- ETF Metrics: Returns performance metrics for Exchange Traded Funds (ETFs).
- Fund Profile: Returns the profile information for a specified fund.
- Fund Sector: Returns the fund sector list.
- Fund Allocation Exposure: Returns the exposure for a specified fund.
- Fund Country: Returns the country list for the specified fund.
- Fund Holding: Returns the holdings list for a specified fund.
- Deprecated Announcements
- Version 0 Maintenance:
- Version 0 (v0) will be maintained until 31.12.2024. After this date, it will be required to switch to Version 1 (v1).
- V1 is released in October 2024 and contains only small changes with the goal of improving the developer experience.
- Changes in (Version 1)
- Indices Constituents:
- The indices constituents endpoint is removed as of 01.05.2024.
- ETF Holdings:
- The field "cusip" will be removed starting from Version 1 (v1) and greater, effective 01.07.2024.
- Stock Candle:
- The endpoint will be removed as of 31.12.2024. Please use the /candle endpoint instead.
New Endpoints
Crypto Price
Endpoint: Crypto Price
Description: This endpoint provides a price quote for a specified cryptocurrency. Over 1000 cryptocurrency symbols are supported.
curl --request POST
--url <https://api.bavest.co/v0/crypto/price>
--header 'accept: application/json'
--header 'content-type: application/json'
--header 'x-api-key: api-key'
--data '{
"symbol": "BTCUSD"
}'
Parameters:
- symbol: The crypto symbol (e.g. BTCUSD)
ETF Metrics
Endpoint: post-etf-metrics (v0)
Description: This endpoint returns performance metrics for Exchange Traded Funds (ETFs).
curl --request POST
--url <https://api.bavest.co/v0/etf/metrics>
--header 'accept: application/json'
--header 'content-type: application/json'
--header 'x-api-key: api-key'
--data '{ "from": 1361290149, "to": 1676588400, "resolution": "D", "currency": "EUR", "symbol": "IWDA.L"}'
Parameters:
- from: Start timestamp (Unix epoch).
- to: End timestamp (Unix epoch).
- resolution: Data resolution (e.g., "D" for daily).
- currency: Currency code (e.g., "EUR").
- symbol: ETF symbol (e.g., "IWDA.L").
ETF Fundamentals
Endpoint: etf-fundamentals (v0)
Description: This endpoint provides fundamental data for specified ETFs.
Sample Request:
curl --request POST
--url <https://api.bavest.co/v0/etf/fundamentals>
--header 'accept: application/json'
--header 'content-type: application/json'
--header 'x-api-key
Fund Allocation Exposure
Endpoint: post-fund-allocation-exposure (v0)
Description: The fund allocation exposure endpoint returns the exposure for a specified fund.
curl --request POST
--url <https://api.bavest.co/v0/fund/allocation-exposure>
--header 'accept: application/json'
--header 'content-type: application/json'
--header 'x-api-key: api-key'
--data '{
"isin": "DE000ETFL573"
}'
Parameters:
- isin: International Securities Identification Number (ISIN) of the fund (e.g., "DE000ETFL573").
Fund Country
Endpoint: post-fund-country (v0)
Description: The fund country endpoint returns the country list for the specified fund.
curl --request POST
--url <https://api.bavest.co/v0/fund/country>
--header 'accept: application/json'
--header 'content-type: application/json'
--header 'x-api-key: api-key'
--data '{
"isin": "DE000ETFL573"
}'
Parameters:
- isin: International Securities Identification Number (ISIN) of the fund (e.g., "DE000ETFL573").
Fund Holding
Endpoint: post-fund-holding (v0)
Description: The fund holding endpoint returns the holdings list for a specified fund.
curl --request POST
--url <https://api.bavest.co/v0/fund/holding>
--header 'accept: application/json'
--header 'content-type: application/json'
--header 'x-api-key: api-key'
--data '{
"isin": "DE000ETFL573"
}'
Parameters:
- isin: International Securities Identification Number (ISIN) of the fund (e.g., "DE000ETFL573").
Fund Profile
Endpoint: post-fund-profile (v0)
Description: The fund holding endpoint returns the holdings list for a specified fund.
curl --request POST
--url <https://api.bavest.co/v0/fund/profile>
--header 'accept: application/json'
--header 'content-type: application/json'
--header 'x-api-key: api-key'
--data '{
"isin": "DE000ETFL573"
}'
Parameters:
- isin: International Securities Identification Number (ISIN) of the fund (e.g., "DE000ETFL573").
Fund Sector
Endpoint: post-fund-sector (v0)
Description: The fund sector endpoint returns the fund sector list.
curl --request POST
--url <https://api.bavest.co/v0/fund/sector>
--header 'accept: application/json'
--header 'content-type: application/json'
--header 'x-api-key: api-key'
--data '{
"isin": "DE000ETFL573"
}'
Parameters:
- isin: International Securities Identification Number (ISIN) of the fund (e.g., "DE000ETFL573").
Deprecations
The following endpoint or fields are removed.
| Affected Endpoint | Information | Migration required | Version | Date |
|---|
| Indices constituents | The indices constituents endpoint was removed. | Yes | > =0 | 01.05.2024 |
| ETF Holdings | The field "cusip" will get removed. Only the version V1 and greater are effected. | Yes | > =1 | 01.07.2024 |
| Stock Candle | The endpoint will get removed. Please use the /candle endpoint. | Yes | > =1 | 31.12.2024 |
Upcoming Deprecation of the Bavest API are announced via E-Mail. If you need more information, send us an E-Mail at: service@bavest.co.
