Quick Links

API Documentation

Access real-time crypto news and sentiment analysis through our RESTful API.

- articles and counting!

Authentication

All API requests require authentication using an API key. You can generate API keys from your dashboard.

API Key Header

Include your API key in the request header:

x-api-key: st_your_api_key_here
Security Note: Never expose your API key in client-side code or public repositories. Keep it secure and rotate it regularly.

Get News Articles

Retrieve the latest crypto news articles and sentiment analysis.

GET /api/v1/news/:batchIndex

Path Parameters

Parameter Type Description
batchIndex integer The batch index to retrieve. Start with 0 for the latest batch, increment for older batches.

Headers

Header Required Description
x-api-key Yes Your API key (format: st_...)

Example Request

curl -X GET "https://steadytrader.app/api/v1/news/0" \
  -H "x-api-key: st_your_api_key_here"

Response Structure

Returns an array of news article objects. Each object contains:

Premium Fields: The fields full_content, credit_to, and metadata are available only for paid subscribers. Free tier users will receive null for these fields.
id (string)
Unique identifier for the news article
title (string)
Headline/title of the news article
summary (string)
Brief summary or excerpt of the article content
timestamp (number)
Unix timestamp (seconds since epoch) indicating when the article was published
image_preview (string | null)
URL to a preview image associated with the article, or null if no image is available
full_content (string | null) Premium
Complete text content of the news article. Premium feature: Returns null for free tier users.
likes (number)
Number of likes or positive reactions the article has received
views (number)
Number of times the article has been viewed
credit_to (string | null) Premium
Author or source attribution for the article. Premium feature: Returns null for free tier users.
metadata (object | null) Premium
Additional metadata about the article. Premium feature: Returns null for free tier users. When available, contains:
interest (string) - Interest level classification (e.g., "Low", "Medium", "High")
score (number) - Relevance or quality score (0-10 scale)
sentiment (string) - Sentiment analysis result (e.g., "Bullish", "Bearish", "Neutral")
tags (array of strings) - Relevant tags or keywords (e.g., cryptocurrency names, projects)

Example Response

[{
  "id": "bd743b97ed6513a1",
  "title": "Hack VC Faces Backlash Over Poor 2025 Investment Performance",
  "summary": "Hack VC is criticized after reporting that over ten of its portfolio projects lost more than 80% of their peak value during 2025, spotlighting significant losses for venture-backed crypto assets.",
  "timestamp": 1767974800.053759,
  "image_preview": null,
  "full_content": "The venture capital firm Hack VC has come under scrutiny following the release of its 2025 performance review. Several prominent projects backed by Hack VC have experienced dramatic declines, with more than ten projects losing over 80% from their all-time highs. Among the steepest losses are MOVE, descending 97.6%, BERA down 96.06%, EIGEN at 92.92%, and SOON falling 92.72%. These disappointing results have provoked critical responses from community members and industry observers concerned about the firm's investment strategy and oversight.",
  "likes": 0,
  "views": 19,
  "credit_to": "Abigail Adams",
  "metadata": {
    "interest": "Medium",
    "score": 6.1,
    "sentiment": "Bearish",
    "tags": ["MOVE", "BERA", "EIGEN", "SOON"]
  }
}]

Get News Article by ID

Retrieve a specific news article by its unique ID.

GET /api/v1/news/get/:id

Path Parameters

Parameter Type Description
id string The unique identifier of the news article (e.g., "bd743b97ed6513a1")

Headers

Header Required Description
x-api-key Yes Your API key (format: st_...)

Response Structure

Returns a single news article object (not an array) with the same structure as the news endpoint.

Premium Fields: The fields full_content, credit_to, and metadata are available only for paid subscribers. Free tier users will receive null for these fields.
id (string)
Unique identifier for the news article
title (string)
Headline/title of the news article
summary (string)
Brief summary or excerpt of the article content
timestamp (number)
Unix timestamp (seconds since epoch) indicating when the article was published
image_preview (string | null)
URL to a preview image associated with the article, or null if no image is available
full_content (string | null) Premium
Complete text content of the news article. Premium feature: Returns null for free tier users.
likes (number)
Number of likes or positive reactions the article has received
views (number)
Number of times the article has been viewed
credit_to (string | null) Premium
Author or source attribution for the article. Premium feature: Returns null for free tier users.
metadata (object | null) Premium
Additional metadata about the article. Premium feature: Returns null for free tier users. When available, contains:
interest (string) - Interest level classification (e.g., "Low", "Medium", "High")
score (number) - Relevance or quality score (0-10 scale)
sentiment (string) - Sentiment analysis result (e.g., "Bullish", "Bearish", "Neutral")
tags (array of strings) - Relevant tags or keywords (e.g., cryptocurrency names, projects)

Example Request

curl -X GET "https://steadytrader.app/api/v1/news/get/bd743b97ed6513a1" \
  -H "x-api-key: st_your_api_key_here"

Example Response

{
  "id": "bd743b97ed6513a1",
  "title": "Hack VC Faces Backlash Over Poor 2025 Investment Performance",
  "summary": "Hack VC is criticized after reporting that over ten of its portfolio projects lost more than 80% of their peak value during 2025, spotlighting significant losses for venture-backed crypto assets.",
  "timestamp": 1767974800.053759,
  "image_preview": null,
  "full_content": "The venture capital firm Hack VC has come under scrutiny following the release of its 2025 performance review. Several prominent projects backed by Hack VC have experienced dramatic declines, with more than ten projects losing over 80% from their all-time highs. Among the steepest losses are MOVE, descending 97.6%, BERA down 96.06%, EIGEN at 92.92%, and SOON falling 92.72%. These disappointing results have provoked critical responses from community members and industry observers concerned about the firm's investment strategy and oversight.",
  "likes": 0,
  "views": 19,
  "credit_to": "Abigail Adams",
  "metadata": {
    "interest": "Medium",
    "score": 6.1,
    "sentiment": "Bearish",
    "tags": ["MOVE", "BERA", "EIGEN", "SOON"]
  }
}

Filter Sparks

Filter and search news articles (sparks) by date range, sentiment, symbols, and other criteria.

POST /api/v1/spark/filter

Request Body

All parameters are optional, but at least one filter parameter must be provided.

Premium Fields: The fields sentiment, symbols, score, and interests are available only for paid subscribers (Starter or Professional plans). Free tier users can use startDate, endDate, limit, likes, and views.
Field Type Required Description
startDate number | string No Start date for filtering. Can be a Unix timestamp (seconds) or ISO 8601 date string. Only articles published on or after this date will be returned.
endDate number | string No* End date for filtering. Can be a Unix timestamp (seconds) or ISO 8601 date string. Only articles published on or before this date will be returned. If provided, startDate must also be provided.
sentiment Premium string | array No Filter by sentiment. Can be a single value or array of values. Valid values: "Bullish", "Bearish", or "Neutral" (e.g., "Bullish" or ["Bullish", "Bearish"]). Premium feature: Available only for paid subscribers.
symbols Premium array of strings No Array of cryptocurrency symbols to filter by (e.g., ["BTC", "ETH", "SOL"]). Only articles mentioning these symbols will be returned. Premium feature: Available only for paid subscribers.
limit number No Maximum number of results to return. Default is 60 if not specified.
score Premium object No Filter by relevance score (0-10). Must be an object with "gt" (greater than) or "lt" (less than) properties. Example: {"gt": 5} for articles with score greater than 5, or {"lt": 8} for articles with score less than 8. You can use both: {"gt": 5, "lt": 8}. Premium feature: Available only for paid subscribers.
interests Premium string | array No Filter by interest level. Can be a single value or array of values. Valid values: "Mega", "High", or "Medium" (e.g., "High" or ["High", "Medium"]). Premium feature: Available only for paid subscribers.
likes object No Filter by number of likes. Must be an object with "gt" (greater than) or "lt" (less than) properties. Example: {"gt": 10} for articles with more than 10 likes, or {"lt": 5} for articles with less than 5 likes. You can use both: {"gt": 5, "lt": 20}.
views object No Filter by number of views. Must be an object with "gt" (greater than) or "lt" (less than) properties. Example: {"gt": 100} for articles with more than 100 views, or {"lt": 50} for articles with less than 50 views. You can use both: {"gt": 50, "lt": 200}.

Headers

Header Required Description
x-api-key Yes Your API key (format: st_...)
Content-Type Yes Must be application/json

Response Structure

Returns an array of news article objects matching the filter criteria. Each object has the same structure as the news endpoint response.

Premium Fields: The fields full_content, credit_to, and metadata are available only for paid subscribers. Free tier users will receive null for these fields.

Example Request

curl -X POST "https://steadytrader.app/api/v1/spark/filter" \
  -H "x-api-key: st_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "sentiment": ["Bullish", "Bearish"],
    "symbols": ["BTC", "ETH"],
    "score": { "gt": 5, "lt": 9 },
    "limit": 10
  }'

Example Request with Date Range

curl -X POST "https://steadytrader.app/api/v1/spark/filter" \
  -H "x-api-key: st_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "startDate": 1767974800,
    "endDate": 1768061200,
    "sentiment": "Bearish",
    "limit": 20
  }'

Example Request with Likes and Views (Free Tier)

curl -X POST "https://steadytrader.app/api/v1/spark/filter" \
  -H "x-api-key: st_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "likes": { "gt": 10 },
    "views": { "gt": 100, "lt": 1000 },
    "limit": 20
  }'

Example Response

[{
  "id": "bd743b97ed6513a1",
  "title": "Bitcoin Reaches New All-Time High",
  "summary": "Bitcoin has reached a new all-time high, breaking previous records...",
  "timestamp": 1767974800.053759,
  "image_preview": null,
  "full_content": "The complete article content...",
  "likes": 42,
  "views": 156,
  "credit_to": "John Doe",
  "metadata": {
    "interest": "High",
    "score": 8.5,
    "sentiment": "Bullish",
    "tags": ["BTC", "Bitcoin", "Cryptocurrency"]
  }
}]
Validation Rules:
  • If no filter parameters are provided, the request will return a 400 error. You must specify at least one filter criterion.
  • If endDate is provided, startDate must also be provided.
  • sentiment, symbols, score, and interests are premium-only fields. Free tier users will receive a 403 error if they attempt to use these fields.
  • score must be a number between 0 and 10 (inclusive).
  • interests can only be one or more of: "Mega", "High", or "Medium".
  • likes and views must be objects with "gt" (greater than) and/or "lt" (less than) properties. Values must be non-negative integers.
  • likes and views are available to all users (free and premium).

Get Engagement Data

Retrieve engagement metrics (likes and views) for a specific news article by its ID.

GET /api/v1/spark/get/engagement/:id

Path Parameters

Parameter Type Description
id string The unique identifier of the news article (e.g., "bd743b97ed6513a1")

Headers

Header Required Description
x-api-key Yes Your API key (format: st_...)

Response Structure

Returns engagement metrics for the specified article.

likes (number)
Number of likes or positive reactions the article has received
views (number)
Number of times the article has been viewed

Example Request

curl -X GET "https://steadytrader.app/api/v1/spark/get/engagement/bd743b97ed6513a1" \
  -H "x-api-key: st_your_api_key_here"

Example Response

{
  "likes": 0,
  "views": 19
}

Get Total Spark Count

Retrieve the total number of articles (sparks) available in the system.

GET /api/v1/spark/get/count

Headers

Header Required Description
x-api-key Yes Your API key (format: st_...)

Response Structure

Returns the total count of articles available in the system.

count (integer)
The total number of articles (sparks) currently available in the system. This number is updated in real-time as new articles are added.

Example Request

curl -X GET "https://steadytrader.app/api/v1/spark/get/count" \
  -H "x-api-key: st_your_api_key_here"

Example Response

{
  "count": 12345
}

Get Votes Count

Retrieve voting statistics (bullish and bearish percentages) for a specific news article by its ID.

GET /api/v1/spark/get/votes/count/:id

Path Parameters

Parameter Type Description
id string The unique identifier of the news article (e.g., "bd743b97ed6513a1")

Headers

Header Required Description
x-api-key Yes Your API key (format: st_...)

Response Structure

Returns voting percentages for the specified article. Both values are percentages ranging from 0 to 100.

Note: The percentages represent the distribution of votes. For example, if 2 people voted (1 bullish, 1 bearish), the response would be {"bullish": 50, "bearish": 50}. The sum of bullish and bearish percentages always equals 100.
bullish (float)
Percentage of users who voted bullish (optimistic) for this article. Range: 0.0 to 100.0
bearish (float)
Percentage of users who voted bearish (pessimistic) for this article. Range: 0.0 to 100.0

Example Request

curl -X GET "https://steadytrader.app/api/v1/spark/get/votes/count/bd743b97ed6513a1" \
  -H "x-api-key: st_your_api_key_here"

Example Response

{
  "bullish": 50.0,
  "bearish": 50.0
}

Get Reviews

Premium Only

Retrieve user reviews for a specific news article by its ID.

Premium Feature: This endpoint is available only for paid subscribers (Starter or Professional plans). Free tier users cannot access this endpoint.
GET /api/v1/spark/get/reviews/:id

Path Parameters

Parameter Type Description
id string The unique identifier of the news article (e.g., "bd743b97ed6513a1")

Headers

Header Required Description
x-api-key Yes Your API key (format: st_...)

Response Structure

Returns an array of review objects. Each review contains:

userId (string)
Unique identifier of the user who wrote the review
id (string)
Unique identifier of the review
createdAt (float)
Unix timestamp (seconds since epoch) indicating when the review was created
content (string)
The text content of the review

Example Request

curl -X GET "https://steadytrader.app/api/v1/spark/get/reviews/bd743b97ed6513a1" \
  -H "x-api-key: st_your_api_key_here"

Example Response

[{
  "userId": "user123",
  "id": "review456",
  "createdAt": 1767974800.5,
  "content": "Great analysis! This article provides valuable insights into the market trends."
}, {
  "userId": "user789",
  "id": "review789",
  "createdAt": 1767974900.2,
  "content": "I disagree with some points, but overall a well-researched piece."
}]

Get Correlation Specs

Premium Only

Analyze the correlation between a news article and market price movements within a specified time window.

Premium Feature: This endpoint is available only for paid subscribers (Starter or Professional plans). Free tier users cannot access this endpoint.
Important Notes:
  • This analysis is only available for news articles with bullish or bearish sentiment. Neutral sentiment articles are not supported.
  • Recommended window sizes: 15 or 30 minutes for best results.
  • This tool provides correlation analysis, not certainty. Use it to identify potential relationships between news and market movements.
  • By adjusting the window parameter, you can explore different time ranges to check for correlations.
GET /api/v1/spark/get/specs/:symbol/:timestamp/:spark_id/:window_minute

Path Parameters

Parameter Type Description
symbol string Trading pair symbol (e.g., "ETH", "BTC", "ETHUSDT"). The symbol should match the cryptocurrency mentioned in the news article.
timestamp integer Unix timestamp (seconds since epoch) of when the news article was published. This is used as the reference point for the correlation analysis.
spark_id string The unique identifier of the news article (e.g., "bd743b97ed6513a1")
window_minute integer Time window in minutes to analyze price movements after the news timestamp. Recommended: 15 or 30 minutes.

Headers

Header Required Description
x-api-key Yes Your API key (format: st_...)

Response Structure

Returns correlation analysis data including price movements, volatility, volume spikes, and causation confidence.

symbol (string)
Trading pair symbol that was analyzed (e.g., "ETHUSDT")
growth_percent (float)
Overall price growth percentage during the analysis window
price_at_timestamp (float)
Price of the asset at the time the news article was published
price_now (float)
Price of the asset at the end of the analysis window
advanced Object

Detailed correlation metrics and analysis:

event_price_change_percent (float)
Price change percentage specifically attributed to the news event
volatility_spike (float)
Measure of volatility increase during the analysis window (0.0 to 1.0 scale)
volume_spike (float)
Measure of trading volume increase during the analysis window (0.0 to 1.0 scale)
abnormal_return (float)
Abnormal return percentage, indicating price movement beyond normal market behavior
sentiment_alignment (boolean)
Whether the price movement aligns with the news sentiment (true if bullish news led to price increase, or bearish news led to price decrease)
causation_confidence (integer)
Confidence score (0-100) indicating how likely the news caused the price movement. Higher values indicate stronger correlation.
message (string)
Human-readable interpretation of the correlation analysis
window (object)
Time window parameters used for analysis:
before - Minutes before the timestamp analyzed
after - Minutes after the timestamp analyzed (matches window_minute parameter)

Example Request

curl -X GET "https://steadytrader.app/api/v1/spark/get/specs/ETH/1768057808/588c0c54adf5c0fd/15" \
  -H "x-api-key: st_your_api_key_here"

Example Response

{
  "symbol": "ETHUSDT",
  "growth_percent": 0.01,
  "price_at_timestamp": 3094.55,
  "price_now": 3094.79,
  "advanced": {
    "event_price_change_percent": -0.0139,
    "volatility_spike": 0.0637,
    "volume_spike": 0.3938,
    "abnormal_return": 0.0113,
    "sentiment_alignment": false,
    "causation_confidence": 46,
    "message": "This spark shows a mild association with ETH's move.",
    "window": {
      "before": 10,
      "after": 15
    }
  }
}

Get Spark Analytics

Premium Only

Retrieve comprehensive sentiment analytics and insights for cryptocurrencies based on news and social media data.

Premium Feature: This endpoint is available only for paid subscribers (Starter or Professional plans). Free tier users cannot access this endpoint.
GET /api/v1/tools/get/spark/analytics

Headers

Header Required Description
x-api-key Yes Your API key (format: st_...)

Example Request

curl -X GET "https://steadytrader.app/api/v1/tools/get/spark/analytics" \
  -H "x-api-key: st_your_api_key_here"

Response Structure

Returns comprehensive analytics data organized into several sections.

Coins Object

Each coin symbol (e.g., "BTC", "ETH") contains detailed analytics data:

coin (string)
Cryptocurrency symbol (e.g., "BTC", "ETH", "SOL")
mentions (number)
Total number of mentions in news articles and social media discussions
sentiment_ratio (number)
Ratio of bullish sentiment, ranging from 0.0 to 1.0. A value of 1.0 means 100% bullish, 0.5 means equal bullish/bearish, and 0.0 means 100% bearish
last_ts (string)
ISO 8601 timestamp of the most recent mention or news article about this coin
sentiment_label (string)
Overall sentiment classification. Possible values: "Strong Bullish", "Bullish", "Neutral", "Bearish", "Strong Bearish"
momentum_label (string)
Momentum classification indicating the rate of change in discussion volume and sentiment. Possible values: "Trending Fast", "Rising", "Stable", "Slowing"
computed24hEvolution Object

Statistical analysis of price movements and sentiment correlations over 24-hour periods:

avg_change_24h (number)
Average 24-hour price change percentage after mentions. Positive values indicate price increases, negative values indicate decreases
overall_sentiment_correlation (number)
Correlation coefficient (0.0 to 1.0) between overall sentiment and price changes. Higher values indicate stronger correlation
bullish_sentiment_correlation (number)
Correlation between bullish sentiment and positive price changes. Measures how well bullish news predicts price increases
bearish_sentiment_correlation (number)
Correlation between bearish sentiment and negative price changes. Measures how well bearish news predicts price decreases
neutral_sentiment_correlation (number)
Correlation between neutral sentiment and price changes. Typically lower as neutral sentiment has less predictive power
avg_change_when_right (object)
Average price change percentage when sentiment correctly predicted the price direction:
bullish - Average price gain when bullish sentiment correctly predicted an increase
bearish - Average price loss when bearish sentiment correctly predicted a decrease (typically negative)
neutral - Average price change when neutral sentiment was correct (typically near 0)
sparks_len (number)
Number of data points (sparks/news articles) used in the statistical analysis. Higher values indicate more reliable correlations
Top Lists
TopBullish (array of strings)
Coins with the highest bullish sentiment ratios, sorted by sentiment strength (most bullish first)
TopDiscussed (array of strings)
Coins with the most mentions in news and social media, sorted by volume (most discussed first)
TopEngaged (array of strings)
Coins with high engagement metrics, indicating active community discussion and interest
TopMomentum (array of strings)
Coins with the fastest growing momentum, showing accelerating discussion volume and sentiment changes
HighInterest (array of strings)
Coins generating high interest and attention, combining multiple factors like mentions, sentiment, and momentum
Report Object
coins (array of objects)
Detailed analysis for each coin with human-readable insights. Each coin object contains:
symbol - Coin symbol (e.g., "BTC", "ETH")
what_is_happenning - Current situation and sentiment overview
price_behavior - How price typically responds to different sentiment conditions
reliability - Assessment of sentiment as a reliable price indicator
in_practical_terms - Practical interpretation and actionable insights
summary (object)
Overall market summary with key insights:
What_is_strongly_trending_today - Description of coins with strong momentum
What_to_keep_an_eye_on - Coins worth monitoring based on current market conditions
Which_coins_are_slowing_down_or_cooling_off - Coins losing momentum or showing signs of cooling interest

Example Response

{
  "coins": {
    "BNB": {
      "coin": "BNB",
      "mentions": 49,
      "sentiment_ratio": 0.653,
      "last_ts": "2026-01-09T13:01:05",
      "sentiment_label": "Strong Bullish",
      "momentum_label": "Slowing",
      "computed24hEvolution": {
        "avg_change_24h": 0.186,
        "overall_sentiment_correlation": 0.469,
        "bullish_sentiment_correlation": 0.541,
        "bearish_sentiment_correlation": 0.4,
        "neutral_sentiment_correlation": 0.143,
        "avg_change_when_right": {
          "bullish": 0.738,
          "bearish": -0.145,
          "neutral": 0.0
        },
        "sparks_len": 49
      }
    }
  },
  "TopBullish": ["BNB", "AVAX", "TAO", "XRP", "SOL"],
  "TopDiscussed": ["BTC", "ETH", "SOL", "XRP"],
  "TopEngaged": ["AVAX", "ZEC", "TAO"],
  "TopMomentum": ["BTC", "ETH"],
  "HighInterest": ["BTC", "ETH", "XRP"],
  "report": {
    "coins": [{
      "symbol": "BNB",
      "what_is_happenning": "BNB is showing strong positive sentiment...",
      "price_behavior": "When bullish sentiment appears for BNB...",
      "reliability": "Bullish sentiment historically aligns well...",
      "in_practical_terms": "BNB is still popular and generally viewed positively..."
    }],
    "summary": {
      "What_is_strongly_trending_today": "Bitcoin (BTC) and Ethereum (ETH)...",
      "What_to_keep_an_eye_on": "Coins like BNB, TAO, and AVAX...",
      "Which_coins_are_slowing_down_or_cooling_off": "BNB, TAO, and AVAX..."
    }
  }
}

Get Coin Data

Retrieve market data and statistics for specific cryptocurrencies including price, market cap, volume, and volatility metrics.

POST /api/v1/get/coin_data

Request Body

Field Type Required Description
symbols array of strings Yes Array of cryptocurrency symbols to fetch data for (e.g., ["BTC", "ETH", "SOL"])

Headers

Header Required Description
x-api-key Yes Your API key (format: st_...)
Content-Type Yes Must be application/json

Response Structure

Returns an array of coin data objects, one for each requested symbol.

symbol (string)
Cryptocurrency symbol (e.g., "BTC", "ETH", "SOL", "XRP")
marketCap (number)
Current market capitalization in USD (total value of all coins in circulation)
price (number)
Current price per coin in USD
priceChange24h (number)
Price change percentage over the last 24 hours. Positive values indicate price increase, negative values indicate decrease
priceChange7d (number)
Price change percentage over the last 7 days
volume24h (number)
Trading volume in USD over the last 24 hours
marketContext Object

Additional market context and historical data:

history Object (optional)
athPrice (number)
All-time high price in USD
atlPrice (number)
All-time low price in USD
athDate (string)
ISO 8601 timestamp when the all-time high was reached
atlDate (string)
ISO 8601 timestamp when the all-time low was reached
distanceFromAthPercent (number)
Percentage distance from all-time high. Negative values indicate current price is below ATH
behavior Object
volatility (object)
Volatility metrics across different time periods (percentage values):
volatility1hPercent - 1-hour volatility
volatility12hPercent - 12-hour volatility
volatility1dPercent - 1-day volatility
volatility7dPercent - 7-day volatility
volatility30dPercent - 30-day volatility
volatility90dPercent - 90-day volatility
avgDailyMovePercent (number)
Average daily price movement percentage, indicating typical price volatility

Example Request

curl -X POST "https://steadytrader.app/api/v1/get/coin_data" \
  -H "x-api-key: st_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "symbols": ["SOL", "XRP"]
  }'

Example Response

[{
  "symbol": "XRP",
  "marketCap": 129027557380.077,
  "price": 2.1314,
  "priceChange24h": -0.341,
  "priceChange7d": 8.7401173,
  "volume24h": 275150714.876,
  "marketContext": {
    "behavior": {
      "volatility": {
        "volatility1hPercent": 0.622,
        "volatility12hPercent": 0.399,
        "volatility1dPercent": 0.399,
        "volatility7dPercent": 0.685,
        "volatility30dPercent": 0.595,
        "volatility90dPercent": 0.622
      },
      "avgDailyMovePercent": 2.027
    }
  }
}, {
  "symbol": "SOL",
  "marketCap": 78775449698.642,
  "price": 139.83,
  "priceChange24h": 1.517,
  "priceChange7d": 6.8897896,
  "volume24h": 529993155.828,
  "marketContext": {
    "history": {
      "athPrice": 293.31,
      "atlPrice": 0.501,
      "athDate": "2025-01-19T11:15:27.957Z",
      "atlDate": "2020-05-11T19:35:23.449Z",
      "distanceFromAthPercent": -52.327
    },
    "behavior": {
      "volatility": {
        "volatility1hPercent": 0.707,
        "volatility12hPercent": 0.271,
        "volatility1dPercent": 0.37,
        "volatility7dPercent": 0.794,
        "volatility30dPercent": 0.759,
        "volatility90dPercent": 0.707
      },
      "avgDailyMovePercent": 2.259
    }
  }
}]

Rate Limits

Rate limits are based on your subscription plan:

Plan Monthly Limit
Free 100 API calls
Starter 10,000 API calls
Professional 500,000 API calls
Rate Limit Headers: When you make a request, the response includes headers showing your current usage:
  • X-RateLimit-Limit - Your monthly limit
  • X-RateLimit-Remaining - Remaining calls this month
  • X-RateLimit-Reset - When the limit resets (Unix timestamp)

Error Responses

401 Unauthorized

Missing or invalid API key:

{
  "error": "API key required"
}

403 Forbidden

Invalid API key or premium feature access denied:

{
  "error": "Premium feature",
  "message": "Spark Analytics is available only for paid subscribers. Please upgrade your plan to access this feature."
}

429 Too Many Requests

Rate limit exceeded:

{
  "error": "Rate limit exceeded",
  "message": "You've reached your monthly limit of 100 API calls. Please upgrade your plan.",
  "limit": 100,
  "used": 100
}

500 Internal Server Error

Server error:

{
  "error": "Failed to fetch news data"
}

Need Help?

If you need assistance or have questions about the API: