SoSoValue API

https://sosovalue-1.gitbook.io/sosovalue-api-doc
Admin
The SoSoValue API provides access to various financial data modules, including currency and pairs,...
Tokens:36,735
Snippets:294
Trust Score:9.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### Query GitBook Documentation via HTTP GET

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/8.-macro

Use this endpoint to dynamically query the documentation. Include your specific question in the 'ask' parameter and an optional 'goal' parameter to guide the AI's response. The response includes a direct answer, relevant excerpts, and sources.

```http
GET https://sosovalue-1.gitbook.io/sosovalue-api-doc/8.-macro.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Fundraising Project List Response Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/7.-fundraising/projects.md

Example of the JSON response when listing fundraising projects. Each project includes its ID and name.

```json
[
    {
        "project_id": 1844233596730036225,
        "project_name": "Crossover Markets"
    }
]
```

--------------------------------

### ETF List Response Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/2.-etf/list.md

This is an example of the JSON response structure when querying the ETF list endpoint.

```json
[
    {
        "ticker": "IBIT",
        "name": "iShares Bitcoin Trust",
        "exchange": "NYSE"
    }
]
```

--------------------------------

### Query Documentation with GET Request

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/9.-analysis-charts

Use this GET request to ask specific questions about the documentation or to retrieve broader context. The 'ask' parameter is mandatory for a specific question, while 'goal' is optional for tailoring the response.

```http
GET https://sosovalue-1.gitbook.io/sosovalue-api-doc/9.-analysis-charts.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation Dynamically

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/2.-etf/market-snapshot.md

To get information not explicitly on this page, make a GET request to the page URL with the 'ask' query parameter. An optional 'goal' parameter can be included to tailor the response.

```http
GET https://sosovalue-1.gitbook.io/sosovalue-api-doc/2.-etf/market-snapshot.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation Dynamically

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/7.-fundraising/projects.md

To get information not explicitly on a page, make a GET request to the page URL with 'ask' and optional 'goal' parameters. 'ask' should be a specific question, and 'goal' describes the overall objective.

```http
GET https://sosovalue-1.gitbook.io/sosovalue-api-doc/7.-fundraising/projects.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### BTC Treasuries List Response Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/5.-btc-treasuries/list.md

This is an example of the JSON response received when querying the BTC Treasuries List endpoint. It shows the structure and fields returned.

```json
[
    {
        "ticker": "TSLA",
        "name": "Tesla",
        "list_location": "US"
    }
]
```

--------------------------------

### Querying Documentation Dynamically

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/4.-crypto-stocks/list.md

To get information not explicitly on this page, make an HTTP GET request to the page URL with the 'ask' query parameter. The optional 'goal' parameter can help tailor the response.

```http
GET https://sosovalue-1.gitbook.io/sosovalue-api-doc/4.-crypto-stocks/list.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### BTC Purchase History Response Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/5.-btc-treasuries/purchase-history.md

This is an example of the JSON response structure for the BTC purchase history endpoint, showing details of a single purchase.

```json
[
    {
        "date": "2024-04-12",
        "ticker": "MSTR",
        "btc_holding": 720737,
        "btc_acq": 3015,
        "acq_cost": 410000000,
        "avg_btc_cost": 75985
    }
]
```

--------------------------------

### Query Documentation API

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/8.-macro/event-history.md

To get information not explicitly on this page, make an HTTP GET request to the page URL with 'ask' and optional 'goal' query parameters.

```http
GET https://sosovalue-1.gitbook.io/sosovalue-api-doc/8.-macro/event-history.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Currency List Response Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/1.-currency-and-pairs/list.md

This is an example of the JSON response structure when requesting the currency list. It includes currency ID, symbol, and name for each currency.

```JSON
[
    {
        "currency_id": "1673723677362319867",
        "symbol": "USDT",
        "name": "USDT"
    },
    ...
]
```

--------------------------------

### News Search Response Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/6.-feeds/search.md

This is an example of a successful response from the news search endpoint. It includes pagination details and a list of news articles, each with its metadata and content.

```json
{
    "code": 0,
    "message": "success",
    "data": {
        "page": 1,
        "page_size": 20,
        "total": 86,
        "list": [
            {
                "id": "news456",
                "source_link": "https://sosovalue.xyz/research/xxx",
                "release_time": 1677151845000,
                "title": "Latest Bitcoin ETF Developments",
                "content": "<p>HTML formatted body...</p>",
                "author": "Researcher A",
                "author_description": "Crypto Analyst",
                "author_avatar_url": "https://...",
                "nick_name": "Analyst ®",
                "is_blue_verified": 1,
                "verified_type": "Business",
                "category": 3,
                "feature_image": "https://xxx.png",
                "matched_currencies": [
                    {
                    "id": "1673723677362319866",
                    "full_name": "BITCOIN",
                    "name": "BTC"
                    }
                ],
                "tags": ["ETF", "BTC"],
                "media_info": [],
                "quote_info": null,
                "type": 3,
                "highlight": {
                    "title": "<em>Bitcoin</em> ETF Latest Developments",
                    "content": "<p>...<em>Bitcoin</em> ETF ...</p>"
                }
            }
        ]
    }
}
```

--------------------------------

### Query GitBook Documentation Dynamically

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/4.-crypto-stocks/market-cap.md

To get information not explicitly on this page, make an HTTP GET request to the page URL with the 'ask' and optional 'goal' query parameters. This allows for dynamic querying of the documentation.

```http
GET https://sosovalue-1.gitbook.io/sosovalue-api-doc/4.-crypto-stocks/market-cap.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Response Example for Historical Supply

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/1.-currency-and-pairs/supply.md

This is an example of the JSON response structure for the historical supply endpoint, showing supply metrics for a specific date.

```json
{
    {
        "date": "2025-10-11",
        "max_supply": "593383314",
        "total_supply": "593383314",
        "circulating_supply": "487043475"
    }
}
```

--------------------------------

### Common Error Examples

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/error-responses.md

Illustrative examples of how common errors are represented in the API response.

```APIDOC
## Common Error Examples

**Parameter validation failure (400):**

```json
{
    "code": 400001,
    "message": "Invalid parameter: currency_id",
    "details": {
        "field": "currency_id",
        "value": "invalid_id",
        "constraint": "must be numeric string",
        "suggestion": "Use GET /currencies to get valid currency IDs"
    }
}
```

**Authentication failure (401):**

```json
{
    "code": 400101,
    "message": "Invalid API Key",
    "details": {
        "header": "X-API-KEY",
        "solution": "Check your API Key or contact support"
    }
}
```

**Resource not found (404):**

```json
{
    "code": 400401,
    "message": "Currency not found",
    "details": {
        "currency_id": "9999999999999999999",
        "suggestion": "Use GET currencies to list available currencies"
    }
}
```
```

--------------------------------

### Crypto Stocks List Response Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/4.-crypto-stocks/list.md

This is an example of the JSON response structure for the crypto stocks list endpoint. It includes details like ticker, name, exchange, sector, and listing time.

```json
[
    {
        "ticker": "TSLA",
        "name": "Tesla",
        "exchange": "NASDAQ",
        "sector": "BTC Treasury",
        "introduction": "",
        "social_media": {
            "website": "",
            "twitter": ""
        },
        "listing_time": "2023-10-11"
    }
]
```

--------------------------------

### Chart Metadata Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/9.-analysis-charts/list.md

Example of the JSON response structure for chart metadata, detailing fields like chart name, time field, and data field definitions.

```json
[
    {
        "chart_name": "stablecoin_total_market_cap",
        "time_field": "timestamp",
        "fields": [
            { "name": "mcap", "type": "number" },
            { "name": "usdt", "type": "number" },
            { "name": "usdc", "type": "number" },
            { "name": "usds", "type": "number" },
            { "name": "usde", "type": "number" },
            { "name": "pyusd", "type": "number" },
            { "name": "usdd", "type": "number" }
        ]
    },
    ...
]
```

--------------------------------

### Fundraising Response Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/1.-currency-and-pairs/fundraising.md

This is an example of the JSON response structure for the currency fundraising endpoint. It outlines the fields returned, including project identifiers, timestamps, fundraising round details, investor information, and portfolio data.

```JSON
{
    "project_id": "1848207131284344834",
    "twitter_username": "defichain",
    "create_time": 1739585768141,
    "update_time": 1739585768141,
    "fundraising_rounds": [
        {
            "round_id": "1858996283520290818",
            "round": "Series A",
            "amount": "15,000,000 USD",
            "valuation": null,
            "date": 1731974400000,
            "investors": [
                {
                    "investor_id": "1844240890553389058",
                    "name": "Paradigm",
                    "logo_url": "https://...",
                    "type": 2,
                    "is_lead_investor": true
                },
                {
                    "investor_id": "1844234867679645697",
                    "name": "Wintermute",
                    "logo_url": "https://...",
                    "type": 1,
                    "is_lead_investor": false
                }
            ]
        }
    ],
    "investors": [ ... ],
    "team": [ ... ],
    "investment_stats": {
        "total_rounds": 0,
        "rounds_last_year": 0,
        "lead_invest_count": 0,
        "last_invest_date": null,
        "portfolio_count": 0
    },
    "portfolio": [
        {
            "project_id": "1844233596960722945",
            "project_name": "Monero",
            "logo_url": "https://...",
            "ecosystems": ["BitTorrent"],
            "established_date": 1728534528350,
            "funding_status": "1844233596855865345",
            "regions": ["UK"]
        }
    ]
}
```

--------------------------------

### Index Constituents Response Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/3.-sosovalue-index/constituents.md

This is an example of the JSON response structure for the index constituents endpoint. It shows the currency symbol and its weight within the index.

```json
[
    {
        "currency_id": "1673723677362319867",
        "symbol": "btc",
        "weight": 0.31
    }
]
```

--------------------------------

### ETF Market Snapshot Response Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/2.-etf/market-snapshot.md

This is an example of the JSON response you will receive when querying the market snapshot endpoint. It includes key metrics like date, ticker, fees, inflows, assets, price, and trading volume.

```json
{
    "date": "2024-04-12",
    "ticker": "IBIT",
    "sponsor_fee": 0.003,
    "net_inflow": 3000000,
    "cum_inflow": 400000000,
    "net_assets": 5000000,
    "mkt_price": 14.5,
    "prem_dsc": -0.0001,
    "value_traded": 4441000000,
    "volume": 322302
}
```

--------------------------------

### Trading Pairs API Response Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/1.-currency-and-pairs/pairs.md

This is an example of the JSON response you can expect when querying for trading pairs. It includes a list of pairs, pagination details, and total count.

```json
{
    "list": [
        {
            "base": "BTC",
            "target": "USDT",
            "market": "Binance",
            "price": 69476,
            "turnover_24h": 20242,
            "cost_to_move_up_usd": 19320706.3958517,
            "cost_to_move_down_usd": 16360235.3694131
        }
    ],
    "page": 1,
    "page_size": 100,
    "total": 542
}
```

--------------------------------

### Crypto Stock Sectors Response Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/4.-crypto-stocks/sector.md

This is an example of the JSON response structure for the crypto stock sectors endpoint, showing sector names, total market capitalization, and 24-hour change percentages.

```json
[
    {
        "sector_name": "all",
        "total_marketcap": 1901100000,
        "change_pct_24h": -0.0023
    },
    {
        "sector_name": "btc treasury",
        "total_marketcap": 1901100000,
        "change_pct_24h": -0.0023
    }
]
```

--------------------------------

### Chart Data Response Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/9.-analysis-charts/chart-data.md

This is an example of the JSON response structure for chart data. The fields include timestamps, net inflow, total assets, and asset prices.

```json
[
    {
        "timestamp": 1710000000000,
        "daily_total_net_inflow": -22700000,
        "total_net_assets": 91400000000,
        "btc_price": 71256
    }
]
```

--------------------------------

### Querying Documentation

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/error-responses.md

Instructions on how to dynamically query the documentation using HTTP GET requests with 'ask' and 'goal' parameters.

```APIDOC
## Querying This Documentation

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://sosovalue-1.gitbook.io/sosovalue-api-doc/error-responses.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
```

--------------------------------

### Event History Response Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/8.-macro/event-history.md

This is an example of the JSON response returned by the Event History API. It shows the date, actual value, forecast, and previous value for an event.

```json
[
    {
        "date": "2025-10-11",
        "actual": 15.8,
        "forecast": 16.2,
        "previous": 12.3
    }
]
```

--------------------------------

### Historical Klines Response Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/3.-sosovalue-index/klines.md

This is an example of the JSON response structure when requesting historical klines. Each object represents a kline with timestamp, open, high, low, and close prices.

```json
[
    {
        "timestamp": 1710000000000,
        "open": 123,
        "high": 130,
        "low": 120,
        "close": 125
    }
]
```

--------------------------------

### Token Economics Response Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/1.-currency-and-pairs/token-economics.md

This is an example of the JSON response structure for the token economics endpoint. It includes token allocation percentages, unlocked and total locked amounts, and a detailed unlock timeline with vesting information.

```json
{
    "token_allocation": [
        {
            "holder": "Community Reserve",
            "percentage": 38
        }
    ],
    "token_unlock": {
        "unlocked": "40500000",
        "total_locked": "1000000"
    },
    "unlock_timeline": [
        {
            "vestings": [
                {
                    "label": "Team",
                    "amount": 159469480.8
                },
                {
                    "label": "Investors",
                    "amount": 135308347.20000008
                }
            ],
            "timestamp": "1234565434567"
        }
    ]
}
```

--------------------------------

### Get Project Detail

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/7.-fundraising/fundraising.md

Retrieves detailed information for a specific crypto fundraising project.

```APIDOC
## GET /fundraising/projects/{project_id}

### Description
Get project detail

### Method
GET

### Endpoint
/fundraising/projects/{project_id}

#### Path Parameters
- **project_id** (string) - Required - The unique identifier of the project.
```

--------------------------------

### Get Project Details

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/7.-fundraising/project-detail.md

Fetches detailed information for a given project ID.

```APIDOC
## GET /fundraising/projects/{project_id}

### Description
Retrieves detailed information about a specific fundraising project using its unique ID.

### Method
GET

### Endpoint
/fundraising/projects/{project_id}

### Parameters
#### Path Parameters
- **project_id** (Number) - No - Project ID

### Response
#### Success Response (200)
- **project_id** (String) - Project ID
- **twitter_username** (String) - Project Twitter username
- **create_time** (Long) - Creation time (timestamp)
- **update_time** (Long) - Last update time (timestamp)
- **fundraising_rounds** (Array[Object]) - Fundraising rounds
  - **round_id** (String) - Round ID
  - **round** (String) - Round name (e.g. Seed, Series A)
  - **amount** (String) - Amount raised
  - **valuation** (String) - Valuation; may be null
  - **date** (Long) - Round date (timestamp)
  - **investors** (Array[Object]) - Investor list
    - **investor_id** (String) - Investor ID
    - **name** (String) - Investor name
    - **logo_url** (String) - Investor logo URL
    - **type** (Integer) - Investor type
    - **is_lead_investor** (Boolean) - Whether lead investor
- **investors** (Array[Object]) - All project investors
- **team** (Array[Object]) - Team members
- **investment_stats** (Object) - Investment statistics
- **portfolio** (Array[Object]) - Portfolio list

### Response Example
{
    "project_id": "1848207131284344834",
    "twitter_username": "defichain",
    "create_time": 1739585768141,
    "update_time": 1739585768141,
    "fundraising_rounds": [
        {
            "round_id": "1858996283520290818",
            "round": "Series A",
            "amount": "15,000,000 USD",
            "valuation": null,
            "date": 1731974400000,
            "investors": [
                {
                    "investor_id": "1844240890553389058",
                    "name": "Paradigm",
                    "logo_url": "https://...",
                    "type": 2,
                    "is_lead_investor": true
                }
            ]
        }
    ],
    "investors": [...],
    "team": [...],
    "investment_stats": {
        "total_rounds": 0,
        "rounds_last_year": 0,
        "lead_invest_count": 0,
        "last_invest_date": null,
        "portfolio_count": 0
    },
    "portfolio": [
        {
            "project_id": "1844233596960722945",
            "project_name": "Monero",
            "logo_url": "https://...",
            "ecosystems": ["BitTorrent"],
            "established_date": 1728534528350,
            "funding_status": "1844233596855865345",
            "regions": ["UK"]
        }
    ]
}
```

--------------------------------

### Sector Index History Response Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/4.-crypto-stocks/sector-index.md

This is an example of the JSON response structure for the Sector Index History API. It includes the date, sector index price, BTC price, and NASDAQ 100 index at that time.

```json
[
    {
        "date": "2024-04-12",
        "price": 123,
        "btc_price": 65000,
        "nasdaq100_index": 88.27
    }
]
```

--------------------------------

### Get Project List

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/7.-fundraising/fundraising.md

Retrieves a list of crypto projects involved in fundraising.

```APIDOC
## GET /fundraising/projects

### Description
Get project list

### Method
GET

### Endpoint
/fundraising/projects
```

--------------------------------

### ETF History Response Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/2.-etf/history.md

This is an example of the JSON response structure for historical ETF data. It includes daily net inflow, cumulative inflow, net assets, currency share, premium/discount rate, value traded, and volume.

```json
[
    {
        "date": "2024-04-12",
        "ticker": "IBIT",
        "net_inflow": 3000000,
        "cum_inflow": 400000000,
        "net_assets": 5000000,
        "currency_share": 0.005,
        "prem_dsc": -0.0001,
        "value_traded": 4441000000,
        "volume": 322302
    }
]
```

--------------------------------

### ETF Summary History Response Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/2.-etf/summary-history.md

This is an example of the JSON response structure for the ETF summary history endpoint. It includes daily trading data such as net inflow, value traded, net assets, and cumulative net inflow.

```json
[
    {
        "date": "2024-04-12",
        "total_net_inflow": -55066297.0000000000000000,
        "total_value_traded": 4706120449.0000000000000000,
        "total_net_assets": 56216535367.0000000000000000,
        "cum_net_inflow": 13534833596.0950000000000000
    },
    {
        "date": "2024-04-11",
        "total_net_inflow": 91269283.0000000000000000,
        "total_value_traded": 2498627928.0000000000000000,
        "total_net_assets": 59225065270.0000000000000000,
        "cum_net_inflow": 12581438056.0950000000000000
    }
]
```

--------------------------------

### Get Market Snapshot

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/1.-currency-and-pairs/market-snapshot.md

Fetches the current market data for a specified currency.

```APIDOC
## GET /currencies/{currency_id}/market-snapshot

### Description
Retrieves the market snapshot for a specific currency, providing detailed metrics such as price, trading volume, and supply.

### Method
GET

### Endpoint
/currencies/{currency_id}/market-snapshot

### Parameters
#### Path Parameters
- **currency_id** (String) - Required - The unique identifier for the currency.

### Response
#### Success Response (200)
- **price** (BigDecimal) - Current price (USD).
- **change_pct_24h** (BigDecimal) - 24-hour price change percentage.
- **turnover_24h** (BigDecimal) - 24-hour trading volume (USD).
- **turnover_rate** (BigDecimal) - Turnover rate.
- **high_24h** (BigDecimal) - 24-hour high price.
- **low_24h** (BigDecimal) - 24-hour low price.
- **marketcap** (BigDecimal) - Market capitalization.
- **fdv** (BigDecimal) - Fully diluted valuation (FDV).
- **max_supply** (String) - Maximum supply; null indicates unlimited.
- **total_supply** (String) - Total supply.
- **circulating_supply** (String) - Circulating supply.
- **ath** (BigDecimal) - All-time high (ATH).
- **ath_date** (String) - ATH date (timestamp).
- **down_from_ath** (String) - Percentage declined from ATH.
- **cycle_low** (BigDecimal) - Cycle low price.
- **cycle_low_date** (String) - Cycle low date (timestamp).
- **up_from_cycle_low** (String) - Percentage recovered from cycle low.
- **marketcap_rank** (Integer) - Market cap rank.

### Response Example
```json
{
    "price": 458.0000000000000000,
    "change_pct_24h": -0.12,
    "turnover_24h": 4381082458.0000000000000000,
    "turnover_rate": 0.123,
    "high_24h": 208.320000000000000000,
    "low_24h": 195.140000000000000000,
    "marketcap": 98187284636.4000000000000000,
    "fdv": 119634407517.24000000,
    "max_supply": "593383314",
    "total_supply": "593383314",
    "circulating_supply": "487043475",
    "ath": 295.830000000000000000,
    "ath_date": "1737244800000",
    "down_from_ath": "",
    "cycle_low": 175.890000000000000000,
    "cycle_low_date": "1738540800000",
    "up_from_cycle_low": "",
    "marketcap_rank": 4
}
```
```

--------------------------------

### Get ETF list

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/2.-etf/etf.md

Retrieves a list of all available ETFs.

```APIDOC
## GET /etfs

### Description
Get ETF list.

### Method
GET

### Endpoint
/etfs
```

--------------------------------

### Querying Documentation

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/query-modes.md

Mechanism to dynamically query the documentation using HTTP GET requests.

```APIDOC
## Querying Documentation

### Description
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter.

### Method
GET

### Endpoint
`https://sosovalue-1.gitbook.io/sosovalue-api-doc/query-modes.md?ask=<question>&goal=<endgoal>`

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question, specific, self-contained, and written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to tailor the answer.
```

--------------------------------

### Get all listed currencies

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/1.-currency-and-pairs/currency.md

Retrieves a list of all currencies supported by the API.

```APIDOC
## GET /currencies

### Description
Get all listed currencies.

### Method
GET

### Endpoint
/currencies
```

--------------------------------

### Index List API Response Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/3.-sosovalue-index/list.md

The API returns a JSON array of strings, where each string is an index ticker.

```json
["ssimag7", "ssilayer1"]
```

--------------------------------

### Query Documentation Dynamically

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/7.-fundraising/fundraising.md

Use this endpoint to ask questions about the documentation. Include your question in the 'ask' parameter and an optional broader goal in the 'goal' parameter.

```http
GET https://sosovalue-1.gitbook.io/sosovalue-api-doc/7.-fundraising/fundraising.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /analyses/{chart_name}

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/9.-analysis-charts/chart-data.md

Fetches historical data for a specified chart. You can filter the data by providing a start time, end time, and a limit for the number of records.

```APIDOC
## GET /analyses/{chart_name}

### Description
Retrieves historical data points for a specific chart, allowing for time-based filtering and result limiting.

### Method
GET

### Endpoint
/analyses/{chart_name}

### Parameters
#### Path Parameters
- **chart_name** (string) - Required - The name of the chart for which to retrieve data.

#### Query Parameters
- **start_time** (long) - Optional - The start of the time range in milliseconds since the Unix epoch.
- **end_time** (long) - Optional - The end of the time range in milliseconds since the Unix epoch.
- **limit** (integer) - Optional - The maximum number of records to return. Defaults to 100, with a maximum of 500.

### Response
#### Success Response (200)
- **timestamp** (Long) - The timestamp of the data point.
- **(dynamic fields)** (Number) - Field names vary per chart and represent specific metrics (e.g., daily_total_net_inflow, total_net_assets, btc_price).

### Response Example
```json
[
    {
        "timestamp": 1710000000000,
        "daily_total_net_inflow": -22700000,
        "total_net_assets": 91400000000,
        "btc_price": 71256
    }
]
```
```

--------------------------------

### Dynamic Documentation Query Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/1.-currency-and-pairs/market-snapshot.md

You can query this documentation dynamically by appending `?ask=<question>&goal=<endgoal>` to the page URL. This allows for specific information retrieval beyond the static content.

```http
GET https://sosovalue-1.gitbook.io/sosovalue-api-doc/1.-currency-and-pairs/market-snapshot.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /currencies/{currency_id}/klines

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/1.-currency-and-pairs/klines.md

Fetches historical kline data for a given currency. Supports filtering by time interval, start and end times, and a limit on the number of results.

```APIDOC
## GET /currencies/{currency_id}/klines

### Description
Retrieves historical kline (candlestick) data for a specified currency. This endpoint allows for filtering by time interval, start and end times, and limiting the number of returned data points.

### Method
GET

### Endpoint
/currencies/{currency_id}/klines

### Parameters
#### Path Parameters
- **currency_id** (String) - Required - The unique identifier for the currency.

#### Query Parameters
- **interval** (string) - Required - The time interval for the klines. Only `1d` (daily) is currently supported.
- **start_time** (timestamp) - Optional - The start of the time range for the klines.
- **end_time** (timestamp) - Optional - The end of the time range for the klines.
- **limit** (integer) - Optional - The maximum number of klines to return. Defaults to 100, with a maximum of 500.

### Response
#### Success Response (200)
- **timestamp** (Long) - The timestamp in milliseconds for the start of the kline period.
- **open** (Number) - The opening price for the kline period.
- **high** (Number) - The highest price reached during the kline period.
- **low** (Number) - The lowest price reached during the kline period.
- **close** (Number) - The closing price for the kline period.
- **volume** (Number) - The total trading volume during the kline period.

#### Response Example
```json
[
    {
        "timestamp": 1710000000000,
        "open": 123,
        "high": 130,
        "low": 120,
        "close": 125,
        "volume": 100000
    }
]
```

### Notes
* Only daily (`1d`) klines are available.
* The query range is limited to the most recent 3 months.
```

--------------------------------

### Resource Not Found Example (404)

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/error-responses.md

Demonstrates an error when a requested resource, like a specific currency, cannot be found. It includes the identifier that was not found and suggests how to list available resources.

```json
{
    "code": 400401,
    "message": "Currency not found",
    "details": {
        "currency_id": "9999999999999999999",
        "suggestion": "Use GET currencies to list available currencies"
    }
}
```

--------------------------------

### Get Sector Index History

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/4.-crypto-stocks/sector-index.md

Fetches historical data for a specified crypto sector index. You can filter the results by providing start and end dates, and control the number of records returned.

```APIDOC
## GET /crypto-stocks/sector/{sector_name}/index

### Description
Retrieves historical data for a specified crypto sector index.

### Method
GET

### Endpoint
/crypto-stocks/sector/{sector_name}/index

### Parameters
#### Path Parameters
- **sector_name** (string) - Required - Sector name

#### Query Parameters
- **start_date** (string) - Optional - Start date
- **end_date** (string) - Optional - End date
- **limit** (string) - Optional - Default 100, max 200

### Response
#### Success Response (200)
- **date** (Long) - Date (timestamp)
- **price** (Number) - Sector index price
- **btc_price** (Number) - BTC price at the same time
- **nasdaq100_index** (Number) - NASDAQ 100 index at the same time

### Response Example
```json
[
    {
        "date": "2024-04-12",
        "price": 123,
        "btc_price": 65000,
        "nasdaq100_index": 88.27
    }
]
```
```

--------------------------------

### Query Documentation Dynamically

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/readme.md

Use this method to ask questions about the documentation when information is not explicitly present on the current page. The `ask` parameter is mandatory for specifying your question, and the `goal` parameter is optional for providing broader context.

```HTTP
GET https://sosovalue-1.gitbook.io/sosovalue-api-doc/readme.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Get ETF Historical Data

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/2.-etf/history.md

Fetches historical data for a given ETF ticker. The query range is limited to the most recent 1 month. You can specify start and end dates, and a limit for the number of records.

```APIDOC
## GET /etfs/{ticker}/history

### Description
Retrieves historical data for a specific ETF.

### Method
GET

### Endpoint
/etfs/{ticker}/history

### Parameters
#### Path Parameters
- **ticker** (string) - Required - ETF ticker

#### Query Parameters
- **start_date** (string) - Optional - Start date. Only the most recent 1 month is supported.
- **end_date** (string) - Optional - End date. Only the most recent 1 month is supported.
- **limit** (integer) - Optional - Default 50 records from start_date, max 300.

### Response
#### Success Response (200)
- **date** (Long) - Data date (timestamp)
- **ticker** (String) - ETF ticker
- **net_inflow** (Number) - Daily net inflow (USD)
- **cum_inflow** (Number) - Cumulative net inflow (USD)
- **net_assets** (Number) - Net assets (USD)
- **currency_share** (Number) - Market share
- **prem_dsc** (Number) - Premium/discount rate
- **value_traded** (Number) - Trading volume (USD)
- **volume** (Number) - Share volume

### Response Example
```json
[
    {
        "date": "2024-04-12",
        "ticker": "IBIT",
        "net_inflow": 3000000,
        "cum_inflow": 400000000,
        "net_assets": 5000000,
        "currency_share": 0.005,
        "prem_dsc": -0.0001,
        "value_traded": 4441000000,
        "volume": 322302
    }
]
```

### Notes
* The query range is limited to the most recent 1 month.
```

--------------------------------

### Query Documentation Index with Ask Parameter

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/llms.txt

Use this GET request to query the documentation index. Provide a specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter to tailor the response.

```http
GET https://sosovalue-1.gitbook.io/sosovalue-api-doc/9.-analysis-charts/list.md?ask=<question>&goal=<end_goal>
```

--------------------------------

### Get Company Historical Market Cap

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/4.-crypto-stocks/market-cap.md

Fetches historical market capitalization data for a specified stock ticker. You can filter the results by providing start and end dates, and control the number of records returned with a limit parameter.

```APIDOC
## GET /crypto-stocks/{stock_ticker}/market-cap

### Description
Retrieves daily market capitalization data for a given stock ticker.

### Method
GET

### Endpoint
/crypto-stocks/{stock_ticker}/market-cap

### Parameters
#### Path Parameters
- **stock_ticker** (string) - Required - Stock ticker

#### Query Parameters
- **start_date** (string) - Optional - Start date
- **end_date** (string) - Optional - End date
- **limit** (integer) - Optional - Default 50, max 100

### Response
#### Success Response (200)
- **date** (Long) - Date (timestamp)
- **market-cap** (Number) - Market capitalization (USD)

#### Response Example
{
    "date": "2024-04-12",
    "market-cap": 14120000000
}
```

--------------------------------

### GET /indices/{index_ticker}/klines

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/3.-sosovalue-index/klines.md

Fetches historical klines for a specified index ticker. Supports filtering by interval, start and end times, and a limit on the number of results. Only daily intervals ('1d') are currently supported, and the query range is limited to the most recent 3 months.

```APIDOC
## GET /indices/{index_ticker}/klines

### Description
Retrieves historical klines (Open, High, Low, Close prices) for a given index ticker. This endpoint is designed to provide time-series data for financial indices.

### Method
GET

### Endpoint
/indices/{index_ticker}/klines

### Parameters
#### Path Parameters
- **ticker** (string) - Yes - Index ticker, e.g. ssimag7

#### Query Parameters
- **interval** (string) - Yes - Time interval. Only `1d` is supported.
- **start_time** (timestamp) - No - Start time.
- **end_time** (timestamp) - No - End time.
- **limit** (integer) - No - Default 100, max 500.

### Response
#### Success Response (200)
- **timestamp** (Long) - Timestamp (milliseconds)
- **open** (Number) - Open price
- **high** (Number) - High price
- **low** (Number) - Low price
- **close** (Number) - Close price

#### Response Example
```json
[
    {
        "timestamp": 1710000000000,
        "open": 123,
        "high": 130,
        "low": 120,
        "close": 125
    }
]
```

### Notes
* Only daily (`1d`) klines are available.
* The query range is limited to the most recent 3 months.
```

--------------------------------

### Querying Documentation Dynamically

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/1.-currency-and-pairs/klines.md

To ask questions about the documentation or retrieve additional context, append `?ask=<question>&goal=<endgoal>` to the page URL. The `ask` parameter is mandatory for specifying the question.

```http
GET https://sosovalue-1.gitbook.io/sosovalue-api-doc/1.-currency-and-pairs/klines.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query GitBook Documentation via HTTP GET

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/7.-fundraising/project-detail.md

Use this endpoint to ask questions about the documentation. Include your specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter. The response will contain direct answers and relevant sources.

```http
GET https://sosovalue-1.gitbook.io/sosovalue-api-doc/7.-fundraising/project-detail.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation with Parameters

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/4.-crypto-stocks/market-snapshot.md

To get additional information not directly on the page, append `?ask=<question>&goal=<endgoal>` to the URL. The `ask` parameter is for the specific question, and `goal` is optional for tailoring the answer.

```http
GET https://sosovalue-1.gitbook.io/sosovalue-api-doc/4.-crypto-stocks/market-snapshot.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/1.-currency-and-pairs/token-economics.md

Use this URL format to query the documentation dynamically by appending 'ask' and optional 'goal' parameters. This is useful for retrieving information not explicitly present on the current page.

```HTTP
GET https://sosovalue-1.gitbook.io/sosovalue-api-doc/1.-currency-and-pairs/token-economics.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Dynamic Documentation Query

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/1.-currency-and-pairs/info.md

You can query the documentation dynamically by performing an HTTP GET request to the page URL with the `ask` query parameter and an optional `goal` parameter. This is useful for retrieving information not explicitly present on the page.

```HTTP
GET https://sosovalue-1.gitbook.io/sosovalue-api-doc/1.-currency-and-pairs/info.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation Dynamically

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/1.-currency-and-pairs/pairs.md

You can dynamically query this documentation by making an HTTP GET request to the page URL with 'ask' and optional 'goal' query parameters.

```http
GET https://sosovalue-1.gitbook.io/sosovalue-api-doc/1.-currency-and-pairs/pairs.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation API Endpoint

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/3.-sosovalue-index/market-snapshot.md

To ask questions about the documentation, perform an HTTP GET request to the page URL with 'ask' and optional 'goal' query parameters.

```http
GET https://sosovalue-1.gitbook.io/sosovalue-api-doc/3.-sosovalue-index/market-snapshot.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/rate-limit.md

You can query this documentation dynamically by performing an HTTP GET request on the current page URL with the `ask` query parameter and an optional `goal` query parameter.

```APIDOC
## Querying This Documentation

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://sosovalue-1.gitbook.io/sosovalue-api-doc/rate-limit.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
```

--------------------------------

### Historical Klines API Response Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/1.-currency-and-pairs/klines.md

This is an example of the JSON response structure for the Historical Klines API. It includes timestamp, open, high, low, close prices, and volume for each kline.

```json
[
    {
        "timestamp": 1710000000000,
        "open": 123,
        "high": 130,
        "low": 120,
        "close": 125,
        "volume": 100000
    }
]
```

--------------------------------

### Sector & Spotlight API Response Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/1.-currency-and-pairs/sector-spotlight.md

This JSON structure illustrates the data returned by the Sector & Spotlight API, showing cryptocurrency sectors and spotlighted assets with their 24-hour price changes and market cap dominance.

```json
{
    "sector": [
        {
            "name": "btc",
            "24h_change_pct": -0.0012,
            "marketcap_dom": 0.58
        }
    ],
    "spotlight": [
        {
            "name": "perpdex",
            "24h_change_pct": -0.0012
        }
    ]
}
```

--------------------------------

### Project Detail Response Example

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/7.-fundraising/project-detail.md

This JSON structure represents the detailed information returned for a specific project. It includes project identifiers, social media links, timestamps, fundraising round details, investor information, team members, investment statistics, and portfolio data.

```json
{
    "project_id": "1848207131284344834",
    "twitter_username": "defichain",
    "create_time": 1739585768141,
    "update_time": 1739585768141,
    "fundraising_rounds": [
        {
            "round_id": "1858996283520290818",
            "round": "Series A",
            "amount": "15,000,000 USD",
            "valuation": null,
            "date": 1731974400000,
            "investors": [
                {
                    "investor_id": "1844240890553389058",
                    "name": "Paradigm",
                    "logo_url": "https://...",
                    "type": 2,
                    "is_lead_investor": true
                }
            ]
        }
    ],
    "investors": [...],
    "team": [...],
    "investment_stats": {
        "total_rounds": 0,
        "rounds_last_year": 0,
        "lead_invest_count": 0,
        "last_invest_date": null,
        "portfolio_count": 0
    },
    "portfolio": [
        {
            "project_id": "1844233596960722945",
            "project_name": "Monero",
            "logo_url": "https://...",
            "ecosystems": ["BitTorrent"],
            "established_date": 1728534528350,
            "funding_status": "1844233596855865345",
            "regions": ["UK"]
        }
    ]
}
```

--------------------------------

### Querying Documentation API

Source: https://sosovalue-1.gitbook.io/sosovalue-api-doc/1.-currency-and-pairs/sector-spotlight.md

To ask questions about the documentation or retrieve additional information not explicitly on the page, use the `ask` query parameter with the documentation URL. An optional `goal` parameter can be included to tailor the response.

```http
GET https://sosovalue-1.gitbook.io/sosovalue-api-doc/1.-currency-and-pairs/sector-spotlight.md?ask=<question>&goal=<endgoal>
```
Tokens:
Raw