(V2) SoSo Value Spot ETF API Doc

Latest version for ETF API. Support for US BTC and ETH ETF data.

1. API Overview

Welcome to the US BTC or ETH Spot ETF API! This API provides a wide range of data points for BTC or ETH spot Exchange-Traded Funds (ETFs), enabling users to access detailed information and metrics that are essential for market analysis and investment decisions. Below are the key data offerings:

Key Data Offerings:

1. Historical ETF Inflow Chart (US BTC or ETH Spot ETFs)

   • Historical day-by-day data for BTC or ETH Spot ETFs, including:

     • Total Net Inflow

     • Total Volume Traded

     • Total Net Assets

     • Cumulative Net Inflow

2. Current ETF Metrics (US BTC or ETH Spot ETFs)

   • Real-time and daily updated metrics for individual and aggregate ETFs, such as:

     • Total Net Assets

     • Total Net Assets Percentage

     • Total Token Holdings

     • Daily Total Net Inflow

     • Cumulative Total Net Inflow

     • Daily Total Value Traded

3. Detailed Current ETF Metrics (US BTC or ETH Spot ETFs)

   • Detailed data for each listed BTC or ETH Spot ETF, offering:

     • Net Assets

     • Net Assets Percentage

     • Daily Net Inflow

     • Cumulative Net Inflow

     • Total Value Traded

     • Management Fee

     • Discount or Premium Rate

These data points are crucial for investors and analysts who need up-to-date information on the behavior of BTC or ETH spot ETFs in the financial markets. The API provides a robust interface for retrieving this data efficiently and effectively.

Base URLs

• Production Environment: https://openapi.sosovalue.com

2. Authentication

All API requests require the use of specific headers to ensure that the request is coming from an authorized source. Below are the details on the headers required and how to obtain them.

Required Headers

• client-id: A unique identifier for the client. You must obtain this ID by contacting the official support to register your application.

• client-secret: A secret key provided to the client to authenticate requests. This key should be kept confidential and only used to authenticate API requests.

Obtaining Your Credentials

To obtain your client-id and client-secret, please follow these steps:

1. Contact the official support team by sending an email to [e-mail] with the subject line "Request for API Access."
2. Provide details about your application or project that will use the API, including your company information and intended use case.

3. Once your request is reviewed, you will receive your credentials via email.

Please ensure that your client-secret is stored securely and not exposed in client-side code or shared publicly. Use these credentials only in server-to-server communications.

3. Endpoints

Historical Inflow Chart API (US BTC or ETH Spot ETFs)

Obtain historical day-by-day data for all spot BTC or ETH ETFs over the past 300 days.

POST /openapi/v2/etf/historicalInflowChart

Request Parameters

type is required (String), samples: "us-btc-spot" or "us-eth-spot"

Sample Request

POST /openapi/v2/etf/historicalInflowChart
Content-Type: application/json

{
    "type": "us-btc-spot"
}

Sample Response

{
  "code": 0, // 0 for success, 1 for fail
  "msg": null,
  "data": {
    "list": [
      {
        "date": "2024-04-12",
        "totalNetInflow": -55066297.0000000000000000,
        "totalValueTraded": 4706120449.0000000000000000,
        "totalNetAssets": 56216535367.0000000000000000,
        "cumNetInflow": 13534833596.0950000000000000
      },
      {
        "date": "2024-04-11",
        "totalNetInflow": 91269283.0000000000000000,
        "totalValueTraded": 2498627928.0000000000000000,
        "totalNetAssets": 59225065270.0000000000000000,
        "cumNetInflow": 12581438056.0950000000000000
      },
      ...
    ]
  }
}

• code field, only 0 for success, 1 means fail.

• Be mindful of the 300-days data provision limit when requesting historical data.

Field	Type	Description
date	string	Date of the daily data. Format: YYYY-MM-DD
totalNetInflow	float	Net inflow into all BTC or ETH ETFs in the day, in USD.
totalValueTraded	float	Total value traded across all BTC or ETH spot ETFs in the day, in USD.
totalNetAssets	float	Combined Value of all BTC or ETH ETFs until the day, in USD.
cumNetInflow	float	Cumulative net inflows since launch of all spot BTC or ETH ETFs until the day, in USD.

Current ETF Data Metrics API (US BTC/ETH Spot ETFs)

Access current daily data for each BTC/ETH spot ETF, and aggregate daily and cumulative metrics.

POST /openapi/v2/etf/currentEtfDataMetrics

Request Parameters

type is required (String), samples: "us-btc-spot" or "us-eth-spot"

Sample Request

POST /openapi/v2/etf/currentEtfDataMetrics
Content-Type: application/json

{
    "type": "us-btc-spot"
}

Sample Response

{
  "code": 0,  // 0 for success, 1 for fail
  "msg": null,
  "data": {
    "totalNetAssets": {
      "value": 53060000000.0,  // Total Net Assets of $53.06B
      "lastUpdateDate": "2024-04-18"
    },
    "totalNetAssetsPercentage": {
      "value": 0.00482,  // Total Net Assets Perventage
      "lastUpdateDate": "2024-04-18"
    },
    "totalTokenHoldings": {
      "value": 120000.0,  // Total Token Holdings, Cryptocurrency-denominated pricing
      "lastUpdateDate": "2024-04-18"
    },
    "dailyNetInflow": {
      "value": -4390000.0,  // Daily Total Net Inflow of -$4.39M
      "lastUpdateDate": "2024-04-18"
    },
    "cumNetInflow": {
      "value": 102400000.0,  // Cumulative Total Net Inflow of $102.4M
      "lastUpdateDate": "2024-04-18"
    },
    "dailyTotalValueTraded": {
      "value": 2570000000.0,  // Daily Total Value Traded of $2.57B
      "lastUpdateDate": "2024-04-18"
    },
    "list": [
      {
        "id": "1746110179689463810",
        "ticker": "GBTC",
        "institute": "Grayscale Investments",
        "netAssets": {
          "value": 7500000000.0,  // Net Assets of $7.5B
          "lastUpdateDate": "2024-04-18",
          "status": "1"  // Updated
        },
        "netAssetsPercentage": {
          "value": 0.0155,  // Net Assets Percentage of 1.55%
          "lastUpdateDate": "2024-04-18",
          "status": "1"  // Updated
        },
        "dailyNetInflow": {
          "value": null,  // Not updated and is thus null
          "lastUpdateDate": "2024-04-17",
          "status": "3"  // Not updated and not counted into total daily net inflow.
        },
        "cumNetInflow": {
          "value": -16380000000.0,   // Cumulative Net Inflow of -$16.38B
          "lastUpdateDate": "2024-04-17",
          "status": "2"  // Not updated today but counted into all etf's total cumulative net inflow.
        },
        "dailyValueTraded": {
          "value": 2580000000.0,  // Total Value Traded of $2.58B
          "lastUpdateDate": "2024-04-18",
          "status": "1"  // Updated
        },
        "fee": {
          "value": 0.009, 
          "lastUpdateDate": "2024-04-18",
          "status": "1"  // Updated
        },
        "discountPremiumRate": {
          "value": -0.0003,
          "lastUpdateDate": "2024-04-18",
          "status": "1"  // Updated
        }
      },
      ...
    ]
  }
}

General Data Fields

Field Name	Type	Description
totalNetAssets	object
- value	float	Combined Value of all BTC or ETH ETFs, in USD.
- lastUpdateDate	string	Format: YYYY-MM-DD
totalNetAssetsPercentage	object
- value	float	The sum of all BTC or ETH spot ETF's net assets / BTC or ETH market cap, where the market cap is the market value at 4 PM New York time on the day.
- lastUpdateDate	string	Format: YYYY-MM-DD
totalTokenHoldings	object
- value	float	Combined number of $BTC or ETH held in all BTC or ETH ETFs. Cryptocurrency-denominated pricing. (This data is an estimate and may differ from the actual figures.)
- lastUpdateDate	string	Format: YYYY-MM-DD
dailyNetInflow	object
- value	float	Net inflow into all BTC or ETH ETFs in the last 24h of open market, in USD.
- lastUpdateDate	string	Format: YYYY-MM-DD
cumNetInflow	object
- value	float	Cumulative net inflows since launch of all spot BTC or ETH ETFs, in USD.
- lastUpdateDate	string	Format: YYYY-MM-DD
dailyTotalValueTraded	object
- value	float	Total daily value traded across all BTC or ETH spot ETFs, in USD.
- lastUpdateDate	string	Format: YYYY-MM-DD

List Data Fields

Field Name	Type	Description
id	string	Unique identifier for the ETF.
ticker	string	Ticker symbol for the ETF.
institute	string	Institution managing the ETF.
netAssets	object
- value	float	Total value of ETF
- lastUpdateDate	string	Format: YYYY-MM-DD
- status	integer	Date update status
netAssetsPercentage	object
- value	float	Net assets / (BTC or ETH) market cap (The market value of BTC or ETH at 4 PM New York time on the day.)
- lastUpdateDate	string	Format: YYYY-MM-DD
- status	integer	Date update status
dailyNetInflow	object
- value	float	Net inflow from last 24h
- lastUpdateDate	string	Format: YYYY-MM-DD
- status	integer	Date update status
cumNetInflow	object
- value	float	Cumulative inflows since launch
- lastUpdateDate	string	Format: YYYY-MM-DD
- status	integer	Date update status
dailyValueTraded	object	Trading value details including value, update date, and status.
- value	float	Trading value on the last update date.
- lastUpdateDate	string	Format: YYYY-MM-DD
- status	integer	Date update status
fee	object
- value	float	Current fee rate for the ETF
- lastUpdateDate	string	Format: YYYY-MM-DD
- status	integer	Date update status
discountPremiumRate	object
- value	float	Discount or premium rate of the ETF
- lastUpdateDate	string	Format: YYYY-MM-DD
- status	integer	Date update status

Data Status Codes

Code	Description
1	Data is freshly updated. This status indicates that the data has been updated most recently. It is directly included in the total calculations and ensures the most accurate and current representation of the values.
2	Data not updated but summed into total fields. This status is applied when data has not been updated on the current day, yet the last updated values are still included in the overall calculations. This approach is generally used for data points where a daily update has a minimal impact on the aggregate results, such as the cumulative net inflow of a small-scale ETF. Including these values in the total helps to expedite the computation of aggregate data without significantly affecting the overall accuracy.
3	Data not updated and not summed into total fields. This status is used when the data has not been updated and is also excluded from total calculations. This decision is based on the potential impact of outdated data on investment decisions. For instance, if daily net inflow data is outdated, including it might lead to incorrect interpretations, such as misrepresenting inflows as outflows, which can significantly alter investment strategies. When status == 3, the data will be null

How SoSo Value Present Data with Data Status Codes

SoSo Value ETF Dashboard