[
  {
    "endpoint": "/public/topics/list/v1",
    "name": "Topics List",
    "description": "Get a list of trending social topics.",
    "parameters": [],
    "changes": [],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "sectionTitle": "topics",
    "score": 1,
    "exampleResponse": "{\n  \"data\": [\n    {\n      \"topic\": \"youtube\", // LunarCrush social topic. Can only includes letters, numbers, spaces, #, and $\n      \"title\": \"YouTube\", // The case sensitive title of the topic or category\n      \"topic_rank\": 1, // LunarCrush metric for ranking a social topic relative to all other social topics\n      \"topic_rank_1h_previous\": 1, // The topic rank from 1 hour ago\n      \"topic_rank_24h_previous\": 1, // The topic rank from 24 hours ago\n      \"num_contributors\": 302979, // The number of unique social contributors to the topic\n      \"num_posts\": 706422, // Total number of posts with interactions on this topic in the last 24 hours\n      \"interactions_24h\": 3814252218 // Number of interactions in the last 24 hours\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/topic/:topic/whatsup/v1",
    "name": "Topic Whatsup",
    "description": "Generate an AI summary of the hottest news and social posts for a specific topic",
    "parameters": [
      {
        "name": "topic",
        "description": "Provide the topic to get a summary for. A topic must be all lower case and can only include letters, numbers, spaces, # and $.",
        "type": "string",
        "example": "bitcoin",
        "required": true
      }
    ],
    "changes": [
      {
        "date": "2025-03-05",
        "description": "Introducing new topic whatsup AI summary endpoint to get summaries of the hottest news and social posts for a specific topic.",
        "type": "new"
      },
      {
        "date": "2025-11-13",
        "description": "Topic whatsup summary endpoint now includes the supportive and critical themes to go along with the main summary.",
        "type": "update"
      }
    ],
    "stale": true,
    "ttl": 2,
    "publicApi": true,
    "upgradedApi": true,
    "development": true,
    "sectionTitle": "topics",
    "score": 1,
    "exampleResponse": "{\n  \"config\": { // This includes the inputs for the request processed by the server and may include additional hints about the request and response information.\n    \"id\": \"bitcoin\", // LunarCrush internal ID for the asset\n    \"_self_call\": true,\n    \"name\": \"Bitcoin\", // The full name of the asset\n    \"symbol\": \"BTC\", // The symbol for the asset\n    \"topic\": \"bitcoin\", // LunarCrush social topic. Can only includes letters, numbers, spaces, #, and $\n    \"generated\": 1781443945 // A unix timestamp (in seconds) when the data was generated to understand possibly stale data\n  },\n  \"summary\": \"Bitcoin holds a 60k floor as regulators hint at upside into the mid-60k range. Macro liquidity risks keep BTC range-bound around the 60k mark.\",\n  \"supportive\": [ // An array of supportive themes with a title, description, and an estimate of the percent of the circulating conversations on social around this theme.\n    {\n      \"title\": \"BTC 60k Floor Holds\", // The case sensitive title of the topic or category\n      \"description\": \"Bitcoin defends the $60k level with robust on-chain demand anchoring the price floor, suggesting a potential move toward mid-$60k if policy clarity improves.\", // Explanation of the change and the potential impact\n      \"percent\": 39.6\n    }\n  ],\n  \"critical\": [ // An array of critical themes with a title, description, and an estimate of the percent of the circulating conversations on social around this theme.\n    {\n      \"title\": \"Policy Clarity Risk Caps Upside\", // The case sensitive title of the topic or category\n      \"description\": \"Unclear or ambiguous regulatory guidance could keep BTC range-bound and cap any upside until direction is clarified.\", // Explanation of the change and the potential impact\n      \"percent\": 11\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/topic/:topic/v1",
    "name": "Topic",
    "description": "Get summary information for a social topic. The output is a 24 hour aggregation social activity with metrics comparing the latest 24 hours to the previous 24 hours.",
    "parameters": [
      {
        "name": "topic",
        "description": "Provide the topic to get details for. A topic must be all lower case and can only include letters, numbers, spaces, # and $. You can also look up a topic by the coin/nft/stock numeric id like coins:1 for bitcoin or stocks:7056 for nVidia.",
        "type": "string",
        "example": "bitcoin",
        "required": true
      }
    ],
    "changes": [
      {
        "date": "2024-04-14",
        "description": "More detailed sentiment information has been added to the topic detail outputs."
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "pure_worker": "public_get_topic_v1",
    "sectionTitle": "topics",
    "score": 1,
    "exampleResponse": "{\n  \"config\": { // This includes the inputs for the request processed by the server and may include additional hints about the request and response information.\n    \"id\": \"bitcoin\", // LunarCrush internal ID for the asset\n    \"_self_call\": true,\n    \"name\": \"Bitcoin\", // The full name of the asset\n    \"symbol\": \"BTC\", // The symbol for the asset\n    \"topic\": \"bitcoin\", // LunarCrush social topic. Can only includes letters, numbers, spaces, #, and $\n    \"generated\": 1781447089 // A unix timestamp (in seconds) when the data was generated to understand possibly stale data\n  },\n  \"data\": {\n    \"topic\": \"bitcoin\", // LunarCrush social topic. Can only includes letters, numbers, spaces, #, and $\n    \"title\": \"Bitcoin\", // The case sensitive title of the topic or category\n    \"topic_rank\": 218, // LunarCrush metric for ranking a social topic relative to all other social topics\n    \"related_topics\": [ // an array of related topics\n      \"coins pow\"\n    ],\n    \"types_count\": { // An object with the counts of the total number of unique posts getting interactions from each social network in the last 24 hours\n      \"tiktok-video\": 10242,\n      \"reddit-post\": 661,\n      \"instagram-post\": 159,\n      \"news\": 283,\n      \"tweet\": 75729,\n      \"youtube-video\": 13723\n    },\n    \"types_interactions\": { // An object with the counts of the total number of interactions on each post from each social network in the last 24 hours\n      \"tiktok-video\": 7428787,\n      \"reddit-post\": 113247,\n      \"instagram-post\": 146673,\n      \"news\": 331558,\n      \"tweet\": 54103459,\n      \"youtube-video\": 24077525\n    },\n    \"types_sentiment\": { // An object with the sentiment score broken down by each supported social network. 0% is all posts negative, 100% is all posts positive. 50% is equal positive and negative posts. Each post is weighted by interactions.\n      \"tiktok-video\": 72,\n      \"reddit-post\": 77,\n      \"news\": 75,\n      \"tweet\": 79,\n      \"youtube-video\": 84\n    },\n    \"types_sentiment_detail\": { // An object with the breakdown of positive, neutral, and negative posts by 24h interactions for each social network\n      \"tiktok-video\": {\n        \"negative\": 1678,\n        \"neutral\": 6236,\n        \"positive\": 2328\n      },\n      \"reddit-post\": {\n        \"negative\": 119,\n        \"neutral\": 341,\n        \"positive\": 201\n      },\n      \"instagram-post\": {\n        \"negative\": 28,\n        \"neutral\": 104,\n        \"positive\": 27\n      },\n      \"news\": {\n        \"negative\": 55,\n        \"neutral\": 143,\n        \"positive\": 85\n      },\n      \"tweet\": {\n        \"negative\": 11100,\n        \"neutral\": 34625,\n        \"positive\": 30004\n      },\n      \"youtube-video\": {\n        \"negative\": 1435,\n        \"neutral\": 8036,\n        \"positive\": 4252\n      }\n    },\n    \"interactions_24h\": 86201249, // Number of interactions in the last 24 hours\n    \"num_contributors\": 40863, // The number of unique social contributors to the topic\n    \"num_posts\": 100797, // Total number of posts with interactions on this topic in the last 24 hours\n    \"categories\": [ // an array of categories this topic aggregates into\n      \"Cryptocurrencies\"\n    ],\n    \"trend\": \"down\" // One of up, down or flat to represent the general trend in interactions\n  }\n}"
  },
  {
    "endpoint": "/public/topic/:topic/time-series/v2",
    "name": "Topic Time Series v2",
    "description": "Get historical time series data for a social topic",
    "parameters": [
      {
        "name": "topic",
        "description": "Provide the topic to get details for. A topic must be all lower case and can only include letters, numbers, spaces, # and $.",
        "type": "string",
        "example": "bitcoin",
        "required": true
      },
      {
        "name": "bucket",
        "description": "Leave blank (default) for the most week aggregated by hour, specify hour for full historical data available in hourly aggregation, specify day for full historical data available in daily aggregation.",
        "type": "string",
        "options": [
          "",
          "hour",
          "day"
        ],
        "default": "latest"
      }
    ],
    "changes": [
      {
        "date": "2025-02-10",
        "description": "New /topics/:topic/time-series/v2 endpoint that includes all available social metrics, additional metrics such as market metrics and combined social and market metrics like AltRank™ and Galaxy Score™.",
        "type": "new"
      },
      {
        "date": "2025-02-12",
        "description": "Update: All time series data will by default provide 1 week of hourly data. When bucket hour is specified it will return all available hourly data, if bucket=day is specified it will return full historical daily data.",
        "type": "update"
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "upgradedApi": true,
    "development": true,
    "pure_worker": "public_topic_time_series_v1",
    "sectionTitle": "topics",
    "score": 1,
    "exampleResponse": "{\n  \"config\": { // This includes the inputs for the request processed by the server and may include additional hints about the request and response information.\n    \"topic\": \"bitcoin\", // LunarCrush social topic. Can only includes letters, numbers, spaces, #, and $\n    \"id\": \"bitcoin\", // LunarCrush internal ID for the asset\n    \"_self_call\": true,\n    \"name\": \"Bitcoin\", // The full name of the asset\n    \"symbol\": \"BTC\", // The symbol for the asset\n    \"interval\": \"1w\", // Typically used for specifying time intervals like 1w = 1 week, 1m = 1 month etc\n    \"start\": 1780790400, // Start/from unix timestamp (in seconds)\n    \"end\": 1781454289, // End/to unix timestamp (in seconds)\n    \"bucket\": \"hour\", // Data is generally bucketed into hours or days\n    \"metrics\": [], // Comma separated list of metrics to include or that are included\n    \"generated\": 1781447089 // A unix timestamp (in seconds) when the data was generated to understand possibly stale data\n  },\n  \"data\": [\n    {\n      \"time\": 1780790400, // A unix timestamp (in seconds)\n      \"alt_rank\": 210, // A proprietary score based on how an asset is performing relative to all other assets supported\n      \"circulating_supply\": 20039087, // Circulating Supply is the total number of coins or tokens that are actively available for trade and are being used in the market and in general public\n      \"close\": 60771, // Close price for the time period\n      \"galaxy_score\": 47, // A proprietary score based on technical indicators of price, average social sentiment, relative social activity, and a factor of how closely social indicators correlate with price and volume\n      \"high\": 60771, // Higest price fo rthe time period\n      \"low\": 60684, // Lowest price for the time period\n      \"market_cap\": 1217425063449, // Total dollar market value of all circulating supply or outstanding shares\n      \"market_dominance\": 58.0952, // The percent of the total market cap that this asset represents\n      \"open\": 60684, // Open price for the time period\n      \"social_dominance\": 29.7652, // The percent of the total social volume that this topic represents\n      \"volume_24h\": 31052912261, // Volume in USD for 24 hours up to this data point\n      \"contributors_active\": 63813, // number of unique social accounts with posts that have interactions\n      \"contributors_created\": 1062, // number of unique social accounts that created new posts\n      \"interactions\": 5479229, // number of all publicly measurable interactions on a social post (views, likes, comments, thumbs up, upvote, share etc)\n      \"posts_active\": 130589, // number of unique social posts with interactions\n      \"posts_created\": 2067, // number of unique social posts created\n      \"sentiment\": 65, // % of posts (weighted by interactions) that are positive. 100% means all posts are positive, 50% is half positive and half negative, and 0% is all negative posts.\n      \"spam\": 9390 // The number of posts created that are considered spam\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/topic/:topic/time-series/v1",
    "name": "Topic Time Series",
    "description": "Get historical time series data for a social topic",
    "parameters": [
      {
        "name": "topic",
        "description": "Provide the topic to get details for. A topic must be all lower case and can only include letters, numbers, spaces, # and $.",
        "type": "string",
        "example": "bitcoin",
        "required": true
      },
      {
        "name": "bucket",
        "description": "bucket time series data into hours or days. default is hours.",
        "type": "string",
        "options": [
          "hour",
          "day"
        ],
        "default": "hour"
      },
      {
        "name": "interval",
        "description": "Use interval to specify the start and end time automatically for convenience. If \"start\" or \"end\" parameters are provided this parameter is ignored.",
        "options": [
          "1d",
          "1w",
          "1m",
          "3m",
          "6m",
          "1y",
          "all"
        ],
        "default": "1w",
        "type": "string"
      },
      {
        "name": "start",
        "description": "The start time (unix timestamp) to go back to.",
        "type": "timestamp"
      },
      {
        "name": "end",
        "description": "The end time (unix timestamp) to stop at.",
        "type": "timestamp"
      }
    ],
    "changes": [
      {
        "date": "2023-12-30",
        "description": "Introducing new topic time series endpoint to get various hourly or daily time series metrics for a topic.",
        "type": "new"
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "upgradedApi": true,
    "pure_worker": "public_topic_time_series_v1",
    "sectionTitle": "topics",
    "score": 1,
    "exampleResponse": "{\n  \"config\": { // This includes the inputs for the request processed by the server and may include additional hints about the request and response information.\n    \"topic\": \"bitcoin\", // LunarCrush social topic. Can only includes letters, numbers, spaces, #, and $\n    \"id\": \"bitcoin\", // LunarCrush internal ID for the asset\n    \"_self_call\": true,\n    \"name\": \"Bitcoin\", // The full name of the asset\n    \"symbol\": \"BTC\", // The symbol for the asset\n    \"interval\": \"1w\", // Typically used for specifying time intervals like 1w = 1 week, 1m = 1 month etc\n    \"start\": 1780790400, // Start/from unix timestamp (in seconds)\n    \"end\": 1781454289, // End/to unix timestamp (in seconds)\n    \"bucket\": \"hour\", // Data is generally bucketed into hours or days\n    \"metrics\": [], // Comma separated list of metrics to include or that are included\n    \"generated\": 1781447089 // A unix timestamp (in seconds) when the data was generated to understand possibly stale data\n  },\n  \"data\": [\n    {\n      \"time\": 1780790400, // A unix timestamp (in seconds)\n      \"alt_rank\": 210, // A proprietary score based on how an asset is performing relative to all other assets supported\n      \"circulating_supply\": 20039087, // Circulating Supply is the total number of coins or tokens that are actively available for trade and are being used in the market and in general public\n      \"close\": 60771, // Close price for the time period\n      \"galaxy_score\": 47, // A proprietary score based on technical indicators of price, average social sentiment, relative social activity, and a factor of how closely social indicators correlate with price and volume\n      \"high\": 60771, // Higest price fo rthe time period\n      \"low\": 60684, // Lowest price for the time period\n      \"market_cap\": 1217425063449, // Total dollar market value of all circulating supply or outstanding shares\n      \"market_dominance\": 58.0952, // The percent of the total market cap that this asset represents\n      \"open\": 60684, // Open price for the time period\n      \"social_dominance\": 29.7652, // The percent of the total social volume that this topic represents\n      \"volume_24h\": 31052912261, // Volume in USD for 24 hours up to this data point\n      \"contributors_active\": 63813, // number of unique social accounts with posts that have interactions\n      \"contributors_created\": 1062, // number of unique social accounts that created new posts\n      \"interactions\": 5479229, // number of all publicly measurable interactions on a social post (views, likes, comments, thumbs up, upvote, share etc)\n      \"posts_active\": 130589, // number of unique social posts with interactions\n      \"posts_created\": 2067, // number of unique social posts created\n      \"sentiment\": 65, // % of posts (weighted by interactions) that are positive. 100% means all posts are positive, 50% is half positive and half negative, and 0% is all negative posts.\n      \"spam\": 9390 // The number of posts created that are considered spam\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/topic/:topic/posts/v1",
    "name": "Topic Posts",
    "description": "Get the top posts for a social topic. If start time is provided the result will be the top posts by interactions for the time range. If start is not provided it will be the most recent top posts by interactions from the last 24 hours.",
    "parameters": [
      {
        "name": "topic",
        "description": "Provide the topic to get details for. A topic must be all lower case and can only include letters, numbers, spaces, # and $.",
        "type": "string",
        "example": "bitcoin",
        "required": true
      },
      {
        "name": "start",
        "description": "The start time (unix timestamp) to start at. Will be rounded to the beginning of the day. If the end parameter is not provided it will just be the top posts for this day.",
        "type": "timestamp"
      },
      {
        "name": "end",
        "description": "(Optional) The end time (unix timestamp) to stop at. Will be rounded to the end of the day.",
        "type": "timestamp"
      }
    ],
    "changes": [
      {
        "date": "2023-11-27",
        "description": "Introducing new topic posts endpoint to get the top social posts for a specific topic.",
        "type": "new"
      },
      {
        "date": "2024-01-08",
        "description": "Now includes the creator avatar url"
      },
      {
        "date": "2024-02-21",
        "description": "Sentiment is now included in the post object."
      },
      {
        "date": "2024-02-22",
        "description": "Post output now includes a link to the original post as key \"post_link\"."
      },
      {
        "date": "2024-02-22",
        "description": "Start and end parameters added so you can fetch the top posts for a specific day or a range of days."
      },
      {
        "date": "2024-08-29",
        "description": "Added the primary image as post_image to the post object if available."
      },
      {
        "date": "2026-02-09",
        "description": "Added the post description/body as post_description to the post object if available."
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "pure_worker": "public_topic_posts_v1",
    "sectionTitle": "topics",
    "score": 1,
    "exampleResponse": "{\n  \"config\": { // This includes the inputs for the request processed by the server and may include additional hints about the request and response information.\n    \"topic\": \"bitcoin\", // LunarCrush social topic. Can only includes letters, numbers, spaces, #, and $\n    \"type\": \"topic\", // Type of item or social network of item e.g. tweet, youtube-video, tiktok, x, youtube, category, topic, creator/influencer\n    \"id\": \"bitcoin\", // Unique id of the social post\n    \"_self_call\": true,\n    \"name\": \"Bitcoin\", // The full name of the asset\n    \"symbol\": \"BTC\", // The symbol for the asset\n    \"generated\": 1781447089 // A unix timestamp (in seconds) when the data was generated to understand possibly stale data\n  },\n  \"data\": [\n    {\n      \"id\": \"2066140826430824823\", // Unique id of the social post\n      \"post_type\": \"tweet\", // The type of social post\n      \"post_title\": \"JUST IN: Michael Saylor hints at buying more Bitcoin. \\n\\\"Still adding dots.\\\"\", // The title text of the social post\n      \"post_link\": \"https://x.com/WatcherGuru/status/2066140826430824823\", // The URL to view the social post on the social network\n      \"post_created\": 1781441334, // The unix timestamp of our best indication of when the post was created\n      \"post_sentiment\": 3, // The sentiment of the post is a score between 1 and 5 with 1 being very negative, 3 being neutral, and 5 being very positive. A score of 3.5 is considered slightly positive.\n      \"creator_id\": \"twitter::1387497871751196672\", // The [network]::[unique_id] for the influencer\n      \"creator_name\": \"WatcherGuru\", // The unique screen name for the influencer\n      \"creator_display_name\": \"Watcher.Guru\", // The chosen display name for the influencer if available\n      \"creator_followers\": 4275618, // number of followers the account has\n      \"creator_avatar\": \"https://pbs.twimg.com/profile_images/1641221212578754562/DfiC0KW2_200x200.png\", // The URL to the avatar for the creator\n      \"interactions_24h\": 85072, // Number of interactions in the last 24 hours\n      \"interactions_total\": 85072, // Number of total interactions\n      \"post_image\": \"https://pbs.twimg.com/media/HKxoIH_aAAAFe2g.jpg\" // The URL to the primary image for the post if available\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/topic/:topic/news/v1",
    "name": "Topic News",
    "description": "Get the top news posts for a social topic. Top news is determined by the metrics related to the social posts that mention the news posts.",
    "parameters": [
      {
        "name": "topic",
        "description": "Provide the topic to get details for. A topic must be all lower case and can only include letters, numbers, spaces, # and $.",
        "type": "string",
        "example": "bitcoin",
        "required": true
      }
    ],
    "changes": [
      {
        "date": "2024-08-29",
        "description": "Introducing new topic news endpoint to get the top news posts for a specific topic.",
        "type": "new"
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "development": true,
    "sectionTitle": "topics",
    "score": 1,
    "exampleResponse": "{\n  \"config\": { // This includes the inputs for the request processed by the server and may include additional hints about the request and response information.\n    \"topic\": \"bitcoin\", // LunarCrush social topic. Can only includes letters, numbers, spaces, #, and $\n    \"type\": \"topic\", // Type of item or social network of item e.g. tweet, youtube-video, tiktok, x, youtube, category, topic, creator/influencer\n    \"id\": \"bitcoin\", // LunarCrush internal ID for the asset\n    \"name\": \"Bitcoin\", // The full name of the asset\n    \"symbol\": \"BTC\", // The symbol for the asset\n    \"generated\": 1781447089 // A unix timestamp (in seconds) when the data was generated to understand possibly stale data\n  },\n  \"data\": [\n    {\n      \"id\": \"news.bitcoin.com-1828443641\", // LunarCrush internal ID for the asset\n      \"post_type\": \"news\", // The type of social post\n      \"post_title\": \"BTC Momentum Turns Positive as Bitcoin Fights to Hold the $64,000 Zone\", // The title text of the social post\n      \"post_description\": \"Bitcoin trades at $64,549 on June 14 with bearish MA signals, neutral oscillators, and bullish 1H and 4H chart structure.\", // The larger text description or body of the social post if available\n      \"post_link\": \"https://news.bitcoin.com/btc-momentum-turns-positive-as-bitcoin-fights-to-hold-the-64000-zone/\", // The URL to view the social post on the social network\n      \"post_created\": 1781440329, // The unix timestamp of our best indication of when the post was created\n      \"post_sentiment\": 3, // The sentiment of the post is a score between 1 and 5 with 1 being very negative, 3 being neutral, and 5 being very positive. A score of 3.5 is considered slightly positive.\n      \"creator_id\": \"twitter::3367334171\", // The [network]::[unique_id] for the influencer\n      \"creator_name\": \"BitcoinNews\", // The unique screen name for the influencer\n      \"creator_display_name\": \"Bitcoin.com News\", // The chosen display name for the influencer if available\n      \"creator_followers\": 3275076, // number of followers the account has\n      \"creator_avatar\": \"https://pbs.twimg.com/profile_images/1917825669825966080/2bAp4kVv_200x200.jpg\", // The URL to the avatar for the creator\n      \"interactions_24h\": 1498, // Number of interactions in the last 24 hours\n      \"interactions_total\": 1498, // Number of total interactions\n      \"post_image\": \"https://static.news.bitcoin.com/wp-content/uploads/2026/06/btc-momentum-turns-positive-as-bitcoin-fights-to-hold-the-64000-zone_nwmk.png\" // The URL to the primary image for the post if available\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/topic/:topic/creators/v1",
    "name": "Topic Creators",
    "description": "Get the top creators for a social topic",
    "parameters": [
      {
        "name": "topic",
        "description": "Provide the topic to get details for. A topic must be all lower case and can only include letters, numbers, spaces, # and $.",
        "type": "string",
        "example": "bitcoin",
        "required": true
      }
    ],
    "changes": [
      {
        "date": "2023-11-27",
        "description": "Introducing new topic creators endpoint to get the current list of trending social creators for a specific topic",
        "type": "new"
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "sectionTitle": "topics",
    "score": 1,
    "exampleResponse": "{\n  \"data\": [\n    {\n      \"creator_id\": \"youtube::UCObE3J0qQ0DzcouV1w4DlGg\", // The [network]::[unique_id] for the influencer\n      \"creator_name\": \"bitcoinliveyt\", // The unique screen name for the influencer\n      \"creator_avatar\": \"https://yt3.ggpht.com/QKZNyoo-1_Iv2ganIMAflJIzvpfWGOADpKF40J6YLVIIz_E_TgCIKAxuYih2dGpbKggly4yq=s88-c-k-c0x00ffffff-no-rj\", // The URL to the avatar for the creator\n      \"creator_followers\": 90800, // number of followers the account has\n      \"creator_rank\": 1, // ranking based on all posts in the last 24 hours that have interactions\n      \"interactions_24h\": 8078988 // Number of interactions in the last 24 hours\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/category/:category/v1",
    "name": "Category",
    "description": "Get summary information for a social category",
    "parameters": [
      {
        "name": "category",
        "description": "Provide the category to get details for. A category must be all lower case and can only include letters, numbers, and spaces. A category is the aggregation of all posts for all topics within the category.",
        "type": "string",
        "example": "musicians",
        "required": true
      }
    ],
    "changes": [
      {
        "date": "2023-11-27",
        "description": "Introducing new category detail endpoint to get details for a specific social category.",
        "type": "new"
      },
      {
        "date": "2025-03-25",
        "description": "Category detail endpoint provides the same data as before and will now also provide the same level of detail as the topic detail endpoint.",
        "type": "update"
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "sectionTitle": "categories",
    "score": 2,
    "exampleResponse": "{\n  \"data\": {\n    \"topic\": \"_musicians\", // LunarCrush social topic. Can only includes letters, numbers, spaces, #, and $\n    \"title\": \"Musicians\", // The case sensitive title of the topic or category\n    \"related_topics\": [ // an array of related topics\n      \"aerosmith\"\n    ],\n    \"types_count\": { // An object with the counts of the total number of unique posts getting interactions from each social network in the last 24 hours\n      \"tiktok-video\": 207956,\n      \"instagram-post\": 1806,\n      \"reddit-post\": 4982,\n      \"youtube-video\": 158441,\n      \"news\": 548,\n      \"tweet\": 204374\n    },\n    \"types_interactions\": { // An object with the counts of the total number of interactions on each post from each social network in the last 24 hours\n      \"tiktok-video\": 1140048708,\n      \"instagram-post\": 43484710,\n      \"reddit-post\": 2218806,\n      \"youtube-video\": 1056332499,\n      \"news\": 3361291,\n      \"tweet\": 610227775\n    },\n    \"types_sentiment\": { // An object with the sentiment score broken down by each supported social network. 0% is all posts negative, 100% is all posts positive. 50% is equal positive and negative posts. Each post is weighted by interactions.\n      \"youtube-video\": 79,\n      \"reddit-post\": 72,\n      \"tweet\": 78,\n      \"news\": 95,\n      \"tiktok-video\": 83\n    },\n    \"types_sentiment_detail\": { // An object with the breakdown of positive, neutral, and negative posts by 24h interactions for each social network\n      \"tiktok-video\": {\n        \"negative\": 28857,\n        \"neutral\": 104078,\n        \"positive\": 75021\n      },\n      \"instagram-post\": {\n        \"negative\": 184,\n        \"neutral\": 973,\n        \"positive\": 649\n      },\n      \"reddit-post\": {\n        \"negative\": 743,\n        \"neutral\": 2246,\n        \"positive\": 1993\n      },\n      \"youtube-video\": {\n        \"negative\": 25648,\n        \"neutral\": 70011,\n        \"positive\": 62782\n      },\n      \"news\": {\n        \"negative\": 86,\n        \"neutral\": 175,\n        \"positive\": 287\n      },\n      \"tweet\": {\n        \"negative\": 33735,\n        \"neutral\": 98345,\n        \"positive\": 72294\n      }\n    },\n    \"interactions_24h\": 2855673789, // Number of interactions in the last 24 hours\n    \"num_contributors\": 303201, // The number of unique social contributors to the topic\n    \"num_posts\": 578107, // Total number of posts with interactions on this topic in the last 24 hours\n    \"trend\": \"down\" // One of up, down or flat to represent the general trend in interactions\n  }\n}"
  },
  {
    "endpoint": "/public/category/:category/topics/v1",
    "name": "Category Topics",
    "description": "Get the top topics for a social category",
    "parameters": [
      {
        "name": "category",
        "description": "Provide the topic to get details for. A topic must be all lower case and can only include letters, numbers, spaces, # and $.",
        "type": "string",
        "example": "musicians",
        "required": true
      }
    ],
    "changes": [
      {
        "date": "2023-11-27",
        "description": "Introducing new category topics endpoint to get the most popular topics within a social category.",
        "type": "new"
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "sectionTitle": "categories",
    "score": 2,
    "exampleResponse": "{\n  \"data\": [\n    {\n      \"topic\": 3038, // LunarCrush social topic. Can only includes letters, numbers, spaces, #, and $\n      \"title\": \"Aerosmith\", // The case sensitive title of the topic or category\n      \"topic_rank\": 2169, // LunarCrush metric for ranking a social topic relative to all other social topics\n      \"topic_rank_1h_previous\": 2169, // The topic rank from 1 hour ago\n      \"topic_rank_24h_previous\": 2206, // The topic rank from 24 hours ago\n      \"num_contributors\": 1274, // The number of unique social contributors to the topic\n      \"social_dominance\": 0.06927307497885654, // The percent of the total social volume that this topic represents\n      \"num_posts\": 2163, // Total number of posts with interactions on this topic in the last 24 hours\n      \"interactions_24h\": 1989447 // Number of interactions in the last 24 hours\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/category/:category/time-series/v1",
    "name": "Category Time Series",
    "description": "Get historical time series data for a social category",
    "parameters": [
      {
        "name": "category",
        "description": "Provide the category to get details for. A category must be all lower case and can only include letters, numbers, and spaces.",
        "type": "string",
        "example": "cryptocurrencies",
        "required": true
      },
      {
        "name": "bucket",
        "description": "bucket time series data into hours or days. default is hours.",
        "type": "string",
        "options": [
          "hour",
          "day"
        ],
        "default": "hour"
      },
      {
        "name": "interval",
        "description": "Use interval to specify the start and end time automatically for convenience. If \"start\" or \"end\" parameters are provided this parameter is ignored.",
        "options": [
          "1d",
          "1w",
          "1m",
          "3m",
          "6m",
          "1y",
          "all"
        ],
        "default": "1w",
        "type": "string"
      },
      {
        "name": "start",
        "description": "The start time (unix timestamp) to go back to.",
        "type": "timestamp"
      },
      {
        "name": "end",
        "description": "The end time (unix timestamp) to stop at.",
        "type": "timestamp"
      }
    ],
    "changes": [
      {
        "date": "2023-11-27",
        "description": "Introducing new category time series endpoint to get time series metrics for a social category.",
        "type": "new"
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "upgradedApi": true,
    "sectionTitle": "categories",
    "score": 2,
    "exampleResponse": "{\n  \"config\": { // This includes the inputs for the request processed by the server and may include additional hints about the request and response information.\n    \"category\": \"cryptocurrencies\", // LunarCrush social category. Can only includes letters, numbers and spaces\n    \"topic\": \"_cryptocurrencies\", // LunarCrush social topic. Can only includes letters, numbers, spaces, #, and $\n    \"type\": \"topic\", // Type of item or social network of item e.g. tweet, youtube-video, tiktok, x, youtube, category, topic, creator/influencer\n    \"id\": \"_cryptocurrencies\", // LunarCrush internal ID for the asset\n    \"interval\": \"1w\", // Typically used for specifying time intervals like 1w = 1 week, 1m = 1 month etc\n    \"start\": 1780790400, // Start/from unix timestamp (in seconds)\n    \"end\": 1781454290, // End/to unix timestamp (in seconds)\n    \"bucket\": \"hour\", // Data is generally bucketed into hours or days\n    \"metrics\": [], // Comma separated list of metrics to include or that are included\n    \"generated\": 1781447090 // A unix timestamp (in seconds) when the data was generated to understand possibly stale data\n  },\n  \"data\": [\n    {\n      \"time\": 1780790400, // A unix timestamp (in seconds)\n      \"contributors_active\": 154657, // number of unique social accounts with posts that have interactions\n      \"contributors_created\": 4115, // number of unique social accounts that created new posts\n      \"interactions\": 13238618, // number of all publicly measurable interactions on a social post (views, likes, comments, thumbs up, upvote, share etc)\n      \"posts_active\": 438730, // number of unique social posts with interactions\n      \"posts_created\": 11108, // number of unique social posts created\n      \"sentiment\": 70, // % of posts (weighted by interactions) that are positive. 100% means all posts are positive, 50% is half positive and half negative, and 0% is all negative posts.\n      \"spam\": 27194, // The number of posts created that are considered spam\n      \"market_cap\": 2095567529991, // Total dollar market value of all circulating supply or outstanding shares\n      \"volume_24h\": 82554271665 // Volume in USD for 24 hours up to this data point\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/category/:category/posts/v1",
    "name": "Category Posts",
    "description": "Get the top posts for a social topic. If start time is provided the result will be the top posts by interactions for the time range. If start is not provided it will be the most recent top posts by interactions from the last 24 hours.",
    "parameters": [
      {
        "name": "category",
        "description": "Provide the category to get details for. A category must be all lower case and can only include letters, numbers, and spaces.",
        "type": "string",
        "example": "cryptocurrencies",
        "required": true
      },
      {
        "name": "start",
        "description": "The start time (unix timestamp) to start at. Will be rounded to the beginning of the day. If the end parameter is not provided it will just be the top posts for this day.",
        "type": "timestamp"
      },
      {
        "name": "end",
        "description": "(Optional) The end time (unix timestamp) to stop at. Will be rounded to the end of the day.",
        "type": "timestamp"
      }
    ],
    "changes": [
      {
        "date": "2024-08-29",
        "description": "Introducing new category news endpoint to get the top news posts for a category.",
        "type": "new"
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "development": true,
    "sectionTitle": "categories",
    "score": 2,
    "exampleResponse": "{\n  \"config\": { // This includes the inputs for the request processed by the server and may include additional hints about the request and response information.\n    \"category\": \"cryptocurrencies\", // LunarCrush social category. Can only includes letters, numbers and spaces\n    \"type\": \"topic\", // Type of item or social network of item e.g. tweet, youtube-video, tiktok, x, youtube, category, topic, creator/influencer\n    \"id\": \"_cryptocurrencies\", // Unique id of the social post\n    \"topic\": \"_cryptocurrencies\", // LunarCrush social topic. Can only includes letters, numbers, spaces, #, and $\n    \"generated\": 1781447090 // A unix timestamp (in seconds) when the data was generated to understand possibly stale data\n  },\n  \"data\": [\n    {\n      \"id\": \"QUmH2GfpusY\", // Unique id of the social post\n      \"post_type\": \"youtube-video\", // The type of social post\n      \"post_title\": \"Promises Kept. Always.\", // The title text of the social post\n      \"post_description\": \"CZ (Changpeng Zhao)'s BNB holdings are substantial, representing the majority of his net worth, with reports from mid-2025 showing his personal stash valued in the tens of billions of dollars, potentially over $70 billion, as BNB tokens hit record highs, though exact figures are speculative due to private holdings, with estimates placing his stake in circulating supply as high as 64%. He confirmed in early 2025 that 98% of his portfolio was BNB, with only 1.32% Bitcoin, underscoring his significant, almost exclusive, bet on the native token of Binance.\", // The larger text description or body of the social post if available\n      \"post_created\": 1781440725, // The unix timestamp of our best indication of when the post was created\n      \"post_sentiment\": 3.07, // The sentiment of the post is a score between 1 and 5 with 1 being very negative, 3 being neutral, and 5 being very positive. A score of 3.5 is considered slightly positive.\n      \"creator_id\": \"youtube::UC7wrEJ5FtgLz4R-0_X8pkOw\", // The [network]::[unique_id] for the influencer\n      \"creator_name\": \"yzilabscn\", // The unique screen name for the influencer\n      \"creator_display_name\": \"YZi Labs\", // The chosen display name for the influencer if available\n      \"creator_followers\": 119000, // number of followers the account has\n      \"creator_avatar\": \"https://yt3.ggpht.com/unPWAoUCyyxRnNpHxXCozNd30CpkXKxx38UNAWsLsRZzE73HnfHeL94yxcBzHAncUEwXpUfx=s88-c-k-c0x00ffffff-no-rj\", // The URL to the avatar for the creator\n      \"interactions_24h\": 50350, // Number of interactions in the last 24 hours\n      \"interactions_total\": 50350 // Number of total interactions\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/category/:category/news/v1",
    "name": "Category News",
    "description": "Get the top news posts for a category. Top news is determined by the metrics related to the social posts that mention the news posts.",
    "parameters": [
      {
        "name": "category",
        "description": "Provide the category to get details for. A category must be all lower case and can only include letters, numbers, and spaces.",
        "type": "string",
        "example": "cryptocurrencies",
        "required": true
      }
    ],
    "changes": [
      {
        "date": "2024-08-29",
        "description": "Introducing new category news endpoint to get the top news posts for a category.",
        "type": "new"
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "development": true,
    "sectionTitle": "categories",
    "score": 2,
    "exampleResponse": "{\n  \"config\": { // This includes the inputs for the request processed by the server and may include additional hints about the request and response information.\n    \"category\": \"cryptocurrencies\", // LunarCrush social category. Can only includes letters, numbers and spaces\n    \"type\": \"topic\", // Type of item or social network of item e.g. tweet, youtube-video, tiktok, x, youtube, category, topic, creator/influencer\n    \"id\": \"_cryptocurrencies\", // LunarCrush internal ID for the asset\n    \"topic\": \"_cryptocurrencies\", // LunarCrush social topic. Can only includes letters, numbers, spaces, #, and $\n    \"generated\": 1781447090 // A unix timestamp (in seconds) when the data was generated to understand possibly stale data\n  },\n  \"data\": [\n    {\n      \"id\": \"theguardian.com-622011072\", // LunarCrush internal ID for the asset\n      \"post_type\": \"news\", // The type of social post\n      \"post_title\": \"UFC to pay White House fighters in crypto issued by Trump company | Trump administration | The Guardian\", // The title text of the social post\n      \"post_description\": \"Some fighters will receive bonuses in ‘stablecoins’ issued by Trump family business World Liberty Financial\", // The larger text description or body of the social post if available\n      \"post_link\": \"https://www.theguardian.com/us-news/2026/jun/14/white-house-ufc-fighters-crypto\", // The URL to view the social post on the social network\n      \"post_image\": \"https://i.guim.co.uk/img/media/28981dac6963fc574a1b4e70dfd6d038be12464c/652_0_6523_5218/master/6523.jpg?width=1200&height=630&quality=85&auto=format&fit=crop&precrop=40:21,offset-x50,offset-y0&overlay-align=bottom%2Cleft&overlay-width=100p&overlay-base64=L2ltZy9zdGF0aWMvb3ZlcmxheXMvdGctZGVmYXVsdC5wbmc&enable=upscale&s=853365a0829c1712db887bee607da3b4\", // The URL to the primary image for the post if available\n      \"post_created\": 1781440863, // The unix timestamp of our best indication of when the post was created\n      \"post_sentiment\": 2.94, // The sentiment of the post is a score between 1 and 5 with 1 being very negative, 3 being neutral, and 5 being very positive. A score of 3.5 is considered slightly positive.\n      \"creator_id\": \"twitter::87818409\", // The [network]::[unique_id] for the influencer\n      \"creator_name\": \"guardian\", // The unique screen name for the influencer\n      \"creator_display_name\": \"The Guardian\", // The chosen display name for the influencer if available\n      \"creator_followers\": 10467523, // number of followers the account has\n      \"creator_avatar\": \"https://pbs.twimg.com/profile_images/1175141826870861825/K2qKoGla_200x200.png\", // The URL to the avatar for the creator\n      \"interactions_24h\": 574, // Number of interactions in the last 24 hours\n      \"interactions_total\": 575 // Number of total interactions\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/category/:category/creators/v1",
    "name": "Category Creators",
    "description": "Get the top creators for a social category",
    "parameters": [
      {
        "name": "category",
        "description": "Provide the category to get details for. A category must be all lower case and can only include letters, numbers, and spaces.",
        "type": "string",
        "example": "musicians",
        "required": true
      }
    ],
    "changes": [
      {
        "date": "2023-11-27",
        "description": "Introducing new category creators endpoint to get the top creators for a social category.",
        "type": "new"
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "sectionTitle": "categories",
    "score": 2,
    "exampleResponse": "{\n  \"data\": [\n    {\n      \"creator_id\": \"youtube::UC5fbutHyWw4n6DRro2c51WQ\", // The [network]::[unique_id] for the influencer\n      \"creator_name\": \"inzu_shorts\", // The unique screen name for the influencer\n      \"creator_avatar\": \"https://yt3.ggpht.com/e6nezKYqBbbWqK6UO24QdS4I52zkEcTB6GV4gj2q_flUqQEajwuR8mTUFeyHLvyN8K_4588KEA=s88-c-k-c0x00ffffff-no-rj\", // The URL to the avatar for the creator\n      \"creator_followers\": 14200000, // number of followers the account has\n      \"creator_rank\": 1, // ranking based on all posts in the last 24 hours that have interactions\n      \"interactions_24h\": 36789700 // Number of interactions in the last 24 hours\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/categories/list/v1",
    "name": "Categories List",
    "description": "Get a list of trending social categories.",
    "parameters": [],
    "changes": [
      {
        "date": "2023-11-27",
        "description": "Introducing new categories endpoint to get the current list of trending social categories.",
        "type": "new"
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "sectionTitle": "categories",
    "score": 2,
    "exampleResponse": "{\n  \"data\": [\n    {\n      \"category\": \"automotive brands\", // LunarCrush social category. Can only includes letters, numbers and spaces\n      \"title\": \"Automotive Brands\", // The case sensitive title of the topic or category\n      \"category_rank\": 10, // LunarCrush metric for ranking a social topic relative to all other social topics\n      \"category_rank_1h_previous\": 10, // The topic rank from 1 hour ago\n      \"category_rank_24h_previous\": 11, // The topic rank from 24 hours ago\n      \"num_contributors\": 310505, // The number of unique social contributors to the topic\n      \"social_dominance\": 2.448811408903175, // The percent of the total social volume that this topic represents\n      \"num_posts\": 571772, // Total number of posts with interactions on this topic in the last 24 hours\n      \"interactions_24h\": 1596477782 // Number of interactions in the last 24 hours\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/creators/list/v1",
    "name": "Creators List",
    "description": "Get a list of trending social creators over all of social based on interactions. To get lists of creators by category or topic see the topics and categories endpoints.",
    "parameters": [],
    "changes": [
      {
        "date": "2023-11-27",
        "description": "Introducing new creators endpoint to get the current list of trending social creators.",
        "type": "new"
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "sectionTitle": "creators",
    "score": 3,
    "exampleResponse": "{\n  \"data\": [\n    {\n      \"creator_name\": \"fifaworldcup\", // The unique screen name for the influencer\n      \"creator_display_name\": \"FIFA World Cup\", // The chosen display name for the influencer if available\n      \"creator_id\": \"7059636734342038534\", // The [network]::[unique_id] for the influencer\n      \"creator_network\": \"tiktok\", // The social network for the post or influencer. We still refer to x as twitter out of developer preference.\n      \"creator_avatar\": \"https://p16-common-sign.tiktokcdn.com/tos-useast2a-avt-0068-euttp/d260685754e3ae8139f47e7ec9fda7e9~tplv-tiktokx-cropcenter:100:100.webp?dr=14579&refresh_token=ae59b68c&x-expires=1781528400&x-signature=KLrxgPYsXOKX3IiqV04yfsTlSf8%3D&t=4d5b0474&ps=13740610&shp=d05b14bd&shcp=34ff8df6&idc=sg1\", // The URL to the avatar for the creator\n      \"creator_followers\": 62723619, // number of followers the account has\n      \"creator_posts\": 437, // total number of posts with interactions in the last 24 hours\n      \"creator_rank\": 1, // ranking based on all posts in the last 24 hours that have interactions\n      \"interactions_24h\": 241125909 // Number of interactions in the last 24 hours\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/creator/:network/:id/v1",
    "name": "Creator",
    "description": "Get detail information on a specific creator",
    "parameters": [
      {
        "name": "network",
        "description": "Provide the network for the creator. One of twitter, youtube, instagram, reddit, or tiktok",
        "type": "string",
        "example": "twitter",
        "required": true
      },
      {
        "name": "id",
        "description": "Provide the unique ID or screen name of the creator",
        "type": "string",
        "example": "elonmusk",
        "required": true
      }
    ],
    "changes": [
      {
        "date": "2023-11-27",
        "description": "Introducing new creator detail endpoint to get details for a specific creator.",
        "type": "new"
      },
      {
        "date": "2025-09-23",
        "description": "Added top_community for for creator detail to showcase the top accounts that mention the creator or that the creator mentions."
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "sectionTitle": "creators",
    "score": 3,
    "exampleResponse": "{\n  \"data\": {\n    \"creator_id\": \"twitter::44196397\", // The [network]::[unique_id] for the influencer\n    \"creator_name\": \"elonmusk\", // The unique screen name for the influencer\n    \"creator_display_name\": \"Elon Musk\", // The chosen display name for the influencer if available\n    \"creator_avatar\": \"https://pbs.twimg.com/profile_images/2053244804520427520/m8mdWZCG_200x200.jpg\", // The URL to the avatar for the creator\n    \"creator_followers\": 240244754, // number of followers the account has\n    \"creator_rank\": 13, // ranking based on all posts in the last 24 hours that have interactions\n    \"interactions_24h\": 95775717, // Number of interactions in the last 24 hours\n    \"topic_influence\": [ // an array of social topics and the creators ranking on each topic\n      {\n        \"topic\": \"spacex\", // LunarCrush social topic. Can only includes letters, numbers, spaces, #, and $\n        \"count\": 38,\n        \"percent\": 5.73,\n        \"rank\": 1\n      }\n    ],\n    \"top_community\": [ // an array of the top accounts that have recently mentioned this creator or that this creator has mentioned\n      {\n        \"creator_name\": \"gadsaad\", // The unique screen name for the influencer\n        \"creator_display_name\": \"Gad Saad\", // The chosen display name for the influencer if available\n        \"creator_avatar\": \"https://pbs.twimg.com/profile_images/979192426660327424/4B9g75QR_200x200.jpg\", // The URL to the avatar for the creator\n        \"count\": 22\n      }\n    ]\n  }\n}"
  },
  {
    "endpoint": "/public/creator/:network/:id/time-series/v1",
    "name": "Creator Time Series",
    "description": "Get time series data on a creator.",
    "parameters": [
      {
        "name": "network",
        "description": "Influencer social network",
        "type": "string",
        "example": "twitter",
        "required": true
      },
      {
        "name": "id",
        "description": "The unique id or screen name of the creator",
        "type": "string",
        "example": "lunarcrush",
        "required": true
      },
      {
        "name": "bucket",
        "description": "bucket time series data into hours or days. default is hours.",
        "type": "string",
        "options": [
          "hour",
          "day"
        ],
        "default": "hour"
      },
      {
        "name": "interval",
        "description": "Use interval to specify the start and end time automatically for convenience. If \"start\" or \"end\" parameters are provided this parameter is ignored.",
        "options": [
          "1d",
          "1w",
          "1m",
          "3m",
          "6m",
          "1y",
          "all"
        ],
        "default": "1w",
        "type": "string"
      },
      {
        "name": "start",
        "description": "The start time (unix timestamp) to go back to.",
        "type": "timestamp"
      },
      {
        "name": "end",
        "description": "The end time (unix timestamp) to stop at.",
        "type": "timestamp"
      }
    ],
    "changes": [
      {
        "date": "2024-03-19",
        "description": "Introducing new creator time series endpoint."
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "sectionTitle": "creators",
    "score": 3,
    "exampleResponse": "{\n  \"config\": { // This includes the inputs for the request processed by the server and may include additional hints about the request and response information.\n    \"network\": \"twitter\", // The social network for the post or influencer. We still refer to x as twitter out of developer preference.\n    \"influencer_id\": \"twitter::988992203568562176\",\n    \"interval\": \"1w\", // Typically used for specifying time intervals like 1w = 1 week, 1m = 1 month etc\n    \"start\": 1780790400, // Start/from unix timestamp (in seconds)\n    \"end\": 1781481600, // End/to unix timestamp (in seconds)\n    \"bucket\": \"hour\", // Data is generally bucketed into hours or days\n    \"name\": \"LunarCrush\", // The full name of the asset\n    \"generated\": 1781447090 // A unix timestamp (in seconds) when the data was generated to understand possibly stale data\n  },\n  \"data\": [\n    {\n      \"time\": 1780790400, // A unix timestamp (in seconds)\n      \"followers\": 303135, // The number of publicly displayed followers the creator has\n      \"interactions\": 132, // number of all publicly measurable interactions on a social post (views, likes, comments, thumbs up, upvote, share etc)\n      \"posts_active\": 12 // number of unique social posts with interactions\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/creator/:network/:id/posts/v1",
    "name": "Creator Posts",
    "description": "Get the top posts for a specific creator. If start time is provided the result will be the top posts by interactions for the time range. If start is not provided it will be the most recent top posts by interactions from the last 24 hours.",
    "parameters": [
      {
        "name": "network",
        "description": "Network for the creator. One of twitter, youtube, instagram, reddit, or tiktok",
        "type": "string",
        "example": "twitter",
        "required": true
      },
      {
        "name": "id",
        "description": "Unique ID or screen name of the creator",
        "type": "string",
        "example": "elonmusk",
        "required": true
      },
      {
        "name": "start",
        "description": "The start time (unix timestamp) to start at. Will be rounded to the beginning of the day. If the end parameter is not provided it will just be the top posts for this day.",
        "type": "timestamp"
      },
      {
        "name": "end",
        "description": "(Optional) The end time (unix timestamp) to stop at. Will be rounded to the end of the day.",
        "type": "timestamp"
      }
    ],
    "changes": [
      {
        "date": "2024-02-21",
        "description": "Introducing new creator posts endpoint to get the top social posts and details for a specific creator.",
        "type": "new"
      },
      {
        "date": "2024-02-21",
        "description": "Sentiment is now included in the post object."
      },
      {
        "date": "2024-02-22",
        "description": "Post output now includes a link to the original post as key \"post_link\"."
      },
      {
        "date": "2024-03-02",
        "description": "Start and end parameters added so you can fetch the top posts for a specific day or a range of days."
      }
    ],
    "stale": true,
    "ttl": 60,
    "publicApi": true,
    "sectionTitle": "creators",
    "score": 3,
    "exampleResponse": "{\n  \"data\": [\n    {\n      \"id\": \"161660285659267072\", // Unique id of the social post\n      \"post_type\": \"tweet\", // The type of social post\n      \"post_title\": \"Design completed for bringing rocket back to launchpad using only thrusters. Yay. Wings r just dead weight in space.\", // The title text of the social post\n      \"post_created\": 1327377790, // The unix timestamp of our best indication of when the post was created\n      \"post_sentiment\": 3, // The sentiment of the post is a score between 1 and 5 with 1 being very negative, 3 being neutral, and 5 being very positive. A score of 3.5 is considered slightly positive.\n      \"post_link\": \"https://x.com/elonmusk/status/161660285659267072\", // The URL to view the social post on the social network\n      \"creator_id\": \"twitter::44196397\", // The [network]::[unique_id] for the influencer\n      \"creator_name\": \"elonmusk\", // The unique screen name for the influencer\n      \"creator_display_name\": \"Elon Musk\", // The chosen display name for the influencer if available\n      \"creator_followers\": 240181991, // number of followers the account has\n      \"creator_avatar\": \"https://pbs.twimg.com/profile_images/2053244804520427520/m8mdWZCG_200x200.jpg\", // The URL to the avatar for the creator\n      \"interactions_24h\": 0, // Number of interactions in the last 24 hours\n      \"interactions_total\": 853 // Number of total interactions\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/posts/:post_type/:post_id/v1",
    "name": "Posts",
    "description": "Get details of a post",
    "parameters": [
      {
        "name": "post_type",
        "description": "The post type e.g. tweet, youtube-video, tiktok-video, reddit-post, instagram-post",
        "type": "string",
        "example": "tweet",
        "required": true
      },
      {
        "name": "post_id",
        "description": "The unique id of a post, for twitter it is a number, youtube it is the id in the url after watch?v=, look in the url for the unique id",
        "type": "string",
        "example": "1756378079893782591",
        "required": true
      }
    ],
    "changes": [
      {
        "date": "2024-02-10",
        "description": "Introducing the post detail endpoint to get details of a single post"
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "sectionTitle": "posts",
    "score": 4,
    "exampleResponse": "{\n  \"type\": \"tweet\", // Type of item or social network of item e.g. tweet, youtube-video, tiktok, x, youtube, category, topic, creator/influencer\n  \"id\": \"1756378079893782591\", // Unique id of the social post\n  \"title\": \"Social activity is 👆 across the board today. \\n\\n🤔 What are y'all talking about? \\n🫡 We've got you covered.\\n\\n👩‍💻 Technology\\n💬 Social Networks\\n👨‍🎤 Musicians\\n🕺 Celebrities\\n🌏 Countries\\n🎮 Gaming\\n🏖️ Travel\\n🚗 Automotive\\n🥷 Cryptocurrencies\\n🇺🇸 US Election\\n\\n🚀 https://t.co/AI5yuZEyi7 https://t.co/T0mqJBiyx0\", // Title of the social post\n  \"description\": null, // Explanation of the change and the potential impact\n  \"extraText\": \"https://lunarcrush.com/categories?rpp=300&page=1&cols=topic_rank%2Ccontributors_active%2Cposts_active%2Caverage_sentiment%2Cinteractions_24h%2Cinteractions_trend\", // Extra text for the post for search matching like the retweet text or text included in the video\n  \"metrics\": { // Comma separated list of metrics to include or that are included\n    \"bookmarks\": 1,\n    \"favorites\": 18,\n    \"retweets\": 3,\n    \"replies\": 12,\n    \"views\": 13009\n  },\n  \"image\": { // Provides the url/src width and height of a the image in the post if available\n    \"src\": \"https://pbs.twimg.com/media/GF_n3GQaoAA23sT.jpg\",\n    \"width\": 2048,\n    \"height\": 989\n  },\n  \"video\": null, // Provides the url/src width and height of a the video in the post if available\n  \"images\": null, // Provides the url/src width and height of a the images in the post if available\n  \"creator_id\": \"twitter::988992203568562176\", // The [network]::[unique_id] for the influencer\n  \"creator_name\": \"LunarCrush\", // The unique screen name for the influencer\n  \"creator_display_name\": \"LunarCrush\", // The chosen display name for the influencer if available\n  \"creator_avatar\": \"https://pbs.twimg.com/profile_images/1958717678476304384/CbzjwJvB_200x200.png\", // The URL to the avatar for the creator\n  \"topics\": [\n    \"lunarcrush\"\n  ],\n  \"categories\": [] // an array of categories this topic aggregates into\n}"
  },
  {
    "endpoint": "/public/posts/:post_type/:post_id/time-series/v1",
    "name": "Posts Time Series",
    "description": "Get interactions over time for a post. If a post is older than 365 days the time series will be returned as daily interactions, otherwise it hourly interactions",
    "parameters": [
      {
        "name": "post_type",
        "description": "The post type e.g. tweet, youtube-video, tiktok-video, reddit-post, instagram-post",
        "type": "string",
        "example": "tweet",
        "required": true
      },
      {
        "name": "post_id",
        "description": "The unique id of a post, for twitter it is a number, youtube it is the id in the url after watch?v=, look in the url for the unique id",
        "type": "string",
        "example": "1756378079893782591",
        "required": true
      }
    ],
    "changes": [
      {
        "date": "2024-02-10",
        "description": "Introduced the post time series endpoint to get the full time series of interactions for a single post",
        "type": "new"
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "sectionTitle": "posts",
    "score": 4,
    "exampleResponse": "{\n  \"data\": [\n    {\n      \"time\": \"1707523200\", // A unix timestamp (in seconds)\n      \"interactions\": 853 // number of all publicly measurable interactions on a social post (views, likes, comments, thumbs up, upvote, share etc)\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/coins/list/v2",
    "name": "Coins List v2",
    "description": "Get a general snapshot of LunarCrush metrics on the entire list of tracked coins. It is designed as a lightweight mechanism for monitoring the universe of available assets, either in aggregate or relative to each other. Metrics include Galaxy Score™, AltRank™, price, volatility, 24h percent change, market cap, social mentions, social interactions, social contributors, social dominance, and categories.",
    "parameters": [
      {
        "name": "sort",
        "description": "sort the output by metric",
        "type": "string",
        "default": "market_cap_rank",
        "options": [
          "id",
          "symbol",
          "name",
          "price",
          "price_btc",
          "volume_24h",
          "volatility",
          "circulating_supply",
          "max_supply",
          "percent_change_1h",
          "percent_change_24h",
          "percent_change_7d",
          "market_cap",
          "market_cap_rank",
          "interactions_24h",
          "social_volume_24h",
          "social_dominance",
          "market_dominance",
          "galaxy_score",
          "galaxy_score_previous",
          "alt_rank",
          "alt_rank_previous",
          "sentiment",
          "blockchain"
        ]
      },
      {
        "name": "filter",
        "description": "filter by sub categories / sector from the \"categories\" key. Separate by commas for multiple matches. Available sectors can be found on the sector filters at https://lunarcrush.com/categories/cryptocurrencies",
        "type": "string",
        "default": ""
      },
      {
        "name": "limit",
        "description": "limit the number of results. Default is 10 maximum is 1000 per page.",
        "type": "number",
        "default": ""
      },
      {
        "name": "desc",
        "description": "Pass any value as desc and the output will be reversed (descending)",
        "type": "boolean"
      },
      {
        "name": "page",
        "description": "When using limit, set the page of results to display, pages start at 0",
        "default": "0"
      }
    ],
    "changes": [
      {
        "date": "2024-01-03",
        "description": "v2 includes market and social data with options to sort and limit by metrics",
        "type": "new"
      },
      {
        "date": "2024-01-26",
        "description": "Logos now available for each entry",
        "type": "update"
      },
      {
        "date": "2024-03-18",
        "description": "Blockchain and contract address info for assets to help clearly identify the asset on chain",
        "type": "update"
      },
      {
        "date": "2024-04-14",
        "description": "Includes the topic to use when looking up social data for this nft collection as a social topic"
      },
      {
        "date": "2024-09-13",
        "description": "Includes sentiment data"
      },
      {
        "date": "2024-12-01",
        "description": "Added filter option to filter the results by specific sub categories/sectors. Try \"meme\" for example."
      },
      {
        "date": "2025-04-28",
        "description": "Increased pagination limit to 1000"
      }
    ],
    "stale": 60,
    "ttl": 30,
    "publicApi": true,
    "upgradedApi": true,
    "pure_worker": "public_coins_index_v1",
    "sectionTitle": "coins",
    "score": 5,
    "exampleResponse": "{\n  \"config\": { // This includes the inputs for the request processed by the server and may include additional hints about the request and response information.\n    \"sort\": \"market_cap_rank\",\n    \"desc\": true,\n    \"limit\": 0,\n    \"page\": 0,\n    \"total_rows\": 5831,\n    \"generated\": 1781447090 // A unix timestamp (in seconds) when the data was generated to understand possibly stale data\n  },\n  \"data\": [\n    {\n      \"id\": 1, // LunarCrush internal ID for the asset\n      \"symbol\": \"BTC\", // The symbol for the asset\n      \"name\": \"Bitcoin\", // The full name of the asset\n      \"price\": 64235.863662046875, // Current price in USD\n      \"price_btc\": 1, // Current price in BTC\n      \"volume_24h\": 16585697421.63, // Volume in USD for 24 hours up to this data point\n      \"volatility\": 0.0057, // Volatility is calculated as the standard deviation of the price.\n      \"circulating_supply\": 20042612, // Circulating Supply is the total number of coins or tokens that are actively available for trade and are being used in the market and in general public\n      \"max_supply\": 21000000, // The maximum supply of the asset if available\n      \"percent_change_1h\": -0.074851407687, // Percent change in price since 1 hour ago\n      \"percent_change_24h\": 0.228987563423, // Percent change in price since 24 hours ago\n      \"percent_change_7d\": 3.584315275162, // Percent change in price since 7 days ago\n      \"market_cap\": 1288585340431, // Total dollar market value of all circulating supply or outstanding shares\n      \"market_cap_rank\": 1, // The rank of the asset by market cap with additional filtering to remove outliers and bad market data.\n      \"interactions_24h\": 86201249, // Number of interactions in the last 24 hours\n      \"social_volume_24h\": 100797, // Total number of posts with interactions on this topic in the last 24 hours\n      \"social_dominance\": 28.321560429556452, // The percent of the total social volume that this topic represents\n      \"market_dominance\": 58.81863880169011, // The percent of the total market cap that this asset represents\n      \"market_dominance_prev\": 58.82832832974712,\n      \"galaxy_score\": 59.5, // A proprietary score based on technical indicators of price, average social sentiment, relative social activity, and a factor of how closely social indicators correlate with price and volume\n      \"galaxy_score_previous\": 52, // The galaxy score from the previous 24 hours\n      \"alt_rank\": 140, // A proprietary score based on how an asset is performing relative to all other assets supported\n      \"alt_rank_previous\": 106, // The alt rank from the previous 24 hours\n      \"sentiment\": 79, // % of posts (weighted by interactions) that are positive. 100% means all posts are positive, 50% is half positive and half negative, and 0% is all negative posts.\n      \"categories\": \"layer-1,bitcoin-ecosystem,pow\", // A comma delimited string of sub categories/sectors this asset belongs to\n      \"blockchains\": [ // An array of blockchains that the asset is part of including the contract address and decimals if applicable\n        {\n          \"type\": \"layer1\", // Type of item or social network of item e.g. tweet, youtube-video, tiktok, x, youtube, category, topic, creator/influencer\n          \"network\": \"bitcoin\", // The name of the blockchain or network\n          \"address\": null, // The contract address, zero or null means it is a layer 1\n          \"decimals\": null\n        }\n      ],\n      \"percent_change_30d\": -18.900206060758, // Percent change in price since 30 days ago\n      \"last_updated_price\": 1781447082,\n      \"last_updated_price_by\": \"cmc_stream\",\n      \"topic\": \"btc bitcoin\", // LunarCrush social topic. Can only includes letters, numbers, spaces, #, and $\n      \"logo\": \"https://cdn.lunarcrush.com/bitcoin.png\" // The URL to the logo for the asset, topic, or category\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/coins/list/v1",
    "name": "Coins List",
    "description": "Get a general snapshot of LunarCrush metrics on the entire list of tracked coins. This version is heavily cached and up to 1 hour behind. It is designed as a lightweight mechanism for monitoring the universe of available assets, either in aggregate or relative to each other. Metrics include Galaxy Score™, AltRank™, price, volatility, 24h percent change, market cap, social mentions, social interactions, social contributors, social dominance, and categories. Use the coins/list/v2 endpoint for data updated every few seconds.",
    "parameters": [
      {
        "name": "sort",
        "description": "sort the output by metric",
        "type": "string",
        "default": "market_cap_rank",
        "options": [
          "id",
          "symbol",
          "name",
          "price",
          "price_btc",
          "volume_24h",
          "volatility",
          "circulating_supply",
          "max_supply",
          "percent_change_1h",
          "percent_change_24h",
          "percent_change_7d",
          "market_cap",
          "market_cap_rank",
          "interactions_24h",
          "social_volume_24h",
          "social_dominance",
          "market_dominance",
          "galaxy_score",
          "galaxy_score_previous",
          "alt_rank",
          "alt_rank_previous",
          "sentiment",
          "blockchain"
        ]
      },
      {
        "name": "filter",
        "description": "filter by sub categories / sector from the \"categories\" key. Separate by commas for multiple matches. Available sectors can be found on the sector filters at https://lunarcrush.com/categories/cryptocurrencies",
        "type": "string",
        "default": ""
      },
      {
        "name": "limit",
        "description": "limit the number of results. Default is 10 maximum is 1000 per page.",
        "type": "number",
        "default": ""
      },
      {
        "name": "desc",
        "description": "Pass any value as desc and the output will be reversed (descending)",
        "type": "boolean"
      },
      {
        "name": "page",
        "description": "When using limit, set the page of results to display, pages start at 0",
        "default": "0"
      }
    ],
    "changes": [
      {
        "date": "2023-11-25",
        "description": "Includes the topic to use when looking up social data for this asset as a social topic",
        "type": "new"
      },
      {
        "date": "2025-04-28",
        "description": "Note that this endpoint is up to 1 hour behind the v2 version. Upgrade to coins/list/v2 for data that is updated every few seconds.",
        "type": "update"
      },
      {
        "date": "2025-04-28",
        "description": "Added sorting and filtering options to allow for smaller faster results.",
        "type": "update"
      }
    ],
    "stale": 3600,
    "ttl": 3600,
    "publicApi": true,
    "pure_worker": "public_coins_index_v1",
    "sectionTitle": "coins",
    "score": 5,
    "exampleResponse": "{\n  \"config\": { // This includes the inputs for the request processed by the server and may include additional hints about the request and response information.\n    \"sort\": \"market_cap_rank\",\n    \"desc\": true,\n    \"limit\": 0,\n    \"page\": 0,\n    \"total_rows\": 5831,\n    \"generated\": 1781447091 // A unix timestamp (in seconds) when the data was generated to understand possibly stale data\n  },\n  \"data\": [\n    {\n      \"id\": 1, // LunarCrush internal ID for the asset\n      \"symbol\": \"BTC\", // The symbol for the asset\n      \"name\": \"Bitcoin\", // The full name of the asset\n      \"price\": 64235.863662046875, // Current price in USD\n      \"price_btc\": 1, // Current price in BTC\n      \"volume_24h\": 16585697421.63, // Volume in USD for 24 hours up to this data point\n      \"volatility\": 0.0057, // Volatility is calculated as the standard deviation of the price.\n      \"circulating_supply\": 20042612, // Circulating Supply is the total number of coins or tokens that are actively available for trade and are being used in the market and in general public\n      \"max_supply\": 21000000, // The maximum supply of the asset if available\n      \"percent_change_1h\": -0.074851407687, // Percent change in price since 1 hour ago\n      \"percent_change_24h\": 0.228987563423, // Percent change in price since 24 hours ago\n      \"percent_change_7d\": 3.584315275162, // Percent change in price since 7 days ago\n      \"market_cap\": 1288585340431, // Total dollar market value of all circulating supply or outstanding shares\n      \"market_cap_rank\": 1, // The rank of the asset by market cap with additional filtering to remove outliers and bad market data.\n      \"interactions_24h\": 86201249, // Number of interactions in the last 24 hours\n      \"social_volume_24h\": 100797, // Total number of posts with interactions on this topic in the last 24 hours\n      \"social_dominance\": 28.321560429556452, // The percent of the total social volume that this topic represents\n      \"market_dominance\": 58.81863880169011, // The percent of the total market cap that this asset represents\n      \"market_dominance_prev\": 58.82832832974712,\n      \"galaxy_score\": 59.5, // A proprietary score based on technical indicators of price, average social sentiment, relative social activity, and a factor of how closely social indicators correlate with price and volume\n      \"galaxy_score_previous\": 52, // The galaxy score from the previous 24 hours\n      \"alt_rank\": 140, // A proprietary score based on how an asset is performing relative to all other assets supported\n      \"alt_rank_previous\": 106, // The alt rank from the previous 24 hours\n      \"sentiment\": 79, // % of posts (weighted by interactions) that are positive. 100% means all posts are positive, 50% is half positive and half negative, and 0% is all negative posts.\n      \"categories\": \"layer-1,bitcoin-ecosystem,pow\", // A comma delimited string of sub categories/sectors this asset belongs to\n      \"blockchains\": [ // An array of blockchains that the asset is part of including the contract address and decimals if applicable\n        {\n          \"type\": \"layer1\", // Type of item or social network of item e.g. tweet, youtube-video, tiktok, x, youtube, category, topic, creator/influencer\n          \"network\": \"bitcoin\", // The name of the blockchain or network\n          \"address\": null, // The contract address, zero or null means it is a layer 1\n          \"decimals\": null\n        }\n      ],\n      \"percent_change_30d\": -18.900206060758, // Percent change in price since 30 days ago\n      \"last_updated_price\": 1781447082,\n      \"last_updated_price_by\": \"cmc_stream\",\n      \"topic\": \"btc bitcoin\", // LunarCrush social topic. Can only includes letters, numbers, spaces, #, and $\n      \"logo\": \"https://cdn.lunarcrush.com/bitcoin.png\" // The URL to the logo for the asset, topic, or category\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/coins/:coin/v1",
    "name": "Coins",
    "description": "Get market data on a coin or token. Specify the coin to be queried by providing the numeric ID or the symbol of the coin in the input parameter, which can be found by calling the /coins/list endpoint.",
    "parameters": [
      {
        "name": "coin",
        "description": "provide the numeric id or symbol of the coin or token.",
        "type": "string",
        "example": "2",
        "required": true
      }
    ],
    "changes": [
      {
        "date": "2023-11-25",
        "description": "The coins endpoint provides the current market data for a crypto asset. Social data has been removed and is available using other endpoints"
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "pure_worker": "public_coins_v1",
    "sectionTitle": "coins",
    "score": 5,
    "exampleResponse": "{\n  \"config\": { // This includes the inputs for the request processed by the server and may include additional hints about the request and response information.\n    \"id\": \"coins:2\", // LunarCrush internal ID for the asset\n    \"_self_call\": true,\n    \"name\": \"Ethereum\", // The full name of the asset\n    \"symbol\": \"ETH\", // The symbol for the asset\n    \"topic\": \"ethereum\", // LunarCrush social topic. Can only includes letters, numbers, spaces, #, and $\n    \"generated\": 1781447091 // A unix timestamp (in seconds) when the data was generated to understand possibly stale data\n  },\n  \"data\": {\n    \"id\": 2, // LunarCrush internal ID for the asset\n    \"name\": \"Ethereum\", // The full name of the asset\n    \"symbol\": \"ETH\", // The symbol for the asset\n    \"price\": 1666.4738941162823, // Current price in USD\n    \"price_btc\": 0.02594564840884439, // Current price in BTC\n    \"market_cap\": 201019186066, // Total dollar market value of all circulating supply or outstanding shares\n    \"percent_change_24h\": -0.69209153363, // Percent change in price since 24 hours ago\n    \"percent_change_7d\": 2.344899458182, // Percent change in price since 7 days ago\n    \"percent_change_30d\": -24.998454393833, // Percent change in price since 30 days ago\n    \"volume_24h\": 5770406369.09, // Volume in USD for 24 hours up to this data point\n    \"max_supply\": null, // The maximum supply of the asset if available\n    \"circulating_supply\": 120684209.11, // Circulating Supply is the total number of coins or tokens that are actively available for trade and are being used in the market and in general public\n    \"close\": 1666.4738941162823, // Close price for the time period\n    \"galaxy_score\": 54.3, // A proprietary score based on technical indicators of price, average social sentiment, relative social activity, and a factor of how closely social indicators correlate with price and volume\n    \"alt_rank\": 130, // A proprietary score based on how an asset is performing relative to all other assets supported\n    \"volatility\": 0.0038, // Volatility is calculated as the standard deviation of the price.\n    \"market_cap_rank\": 2 // The rank of the asset by market cap with additional filtering to remove outliers and bad market data.\n  }\n}"
  },
  {
    "endpoint": "/public/coins/:coin/time-series/v2",
    "name": "Coins Time Series",
    "description": "Get market time series data on a coin or token. Specify the coin to be queried by providing the numeric ID or the symbol of the coin in the input parameter, which can be found by calling the /coins/list endpoint.",
    "parameters": [
      {
        "name": "coin",
        "description": "provide the numeric id or symbol of the coin or token.",
        "type": "string",
        "example": "2",
        "required": true
      },
      {
        "name": "bucket",
        "description": "bucket time series data into hours or days. default is hours.",
        "type": "string",
        "options": [
          "hour",
          "day"
        ],
        "default": "hour"
      },
      {
        "name": "interval",
        "description": "Use interval to specify the start and end time automatically for convenience. If \"start\" or \"end\" parameters are provided this parameter is ignored.",
        "options": [
          "1d",
          "1w",
          "1m",
          "3m",
          "6m",
          "1y",
          "all"
        ],
        "default": "1w",
        "type": "string"
      },
      {
        "name": "start",
        "description": "The start time (unix timestamp) to go back to.",
        "type": "timestamp"
      },
      {
        "name": "end",
        "description": "The end time (unix timestamp) to stop at.",
        "type": "timestamp"
      }
    ],
    "changes": [
      {
        "date": "2024-01-04",
        "description": "Introducing new coin time series endpoint v2 that includes market and social data combined."
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "pure_worker": "public_coins_time_series_v2",
    "sectionTitle": "coins",
    "score": 5,
    "exampleResponse": "{\n  \"config\": { // This includes the inputs for the request processed by the server and may include additional hints about the request and response information.\n    \"coin\": \"2\",\n    \"topic\": \"ethereum\", // LunarCrush social topic. Can only includes letters, numbers, spaces, #, and $\n    \"id\": \"coins:2\", // LunarCrush internal ID for the asset\n    \"_self_call\": true,\n    \"name\": \"Ethereum\", // The full name of the asset\n    \"symbol\": \"ETH\", // The symbol for the asset\n    \"interval\": \"1w\", // Typically used for specifying time intervals like 1w = 1 week, 1m = 1 month etc\n    \"start\": 1780790400, // Start/from unix timestamp (in seconds)\n    \"end\": 1781454291, // End/to unix timestamp (in seconds)\n    \"bucket\": \"hour\", // Data is generally bucketed into hours or days\n    \"metrics\": [], // Comma separated list of metrics to include or that are included\n    \"generated\": 1781447091 // A unix timestamp (in seconds) when the data was generated to understand possibly stale data\n  },\n  \"data\": [\n    {\n      \"time\": 1780790400, // A unix timestamp (in seconds)\n      \"contributors_active\": 26334, // number of unique social accounts with posts that have interactions\n      \"contributors_created\": 409, // number of unique social accounts that created new posts\n      \"interactions\": 1381428, // number of all publicly measurable interactions on a social post (views, likes, comments, thumbs up, upvote, share etc)\n      \"posts_active\": 46371, // number of unique social posts with interactions\n      \"posts_created\": 725, // number of unique social posts created\n      \"sentiment\": 68, // % of posts (weighted by interactions) that are positive. 100% means all posts are positive, 50% is half positive and half negative, and 0% is all negative posts.\n      \"spam\": 4955, // The number of posts created that are considered spam\n      \"alt_rank\": 340, // A proprietary score based on how an asset is performing relative to all other assets supported\n      \"circulating_supply\": 120684554, // Circulating Supply is the total number of coins or tokens that are actively available for trade and are being used in the market and in general public\n      \"close\": 1564.7954, // Close price for the time period\n      \"galaxy_score\": 51, // A proprietary score based on technical indicators of price, average social sentiment, relative social activity, and a factor of how closely social indicators correlate with price and volume\n      \"high\": 1564.32, // Higest price fo rthe time period\n      \"low\": 1561.07, // Lowest price for the time period\n      \"market_cap\": 188881264263, // Total dollar market value of all circulating supply or outstanding shares\n      \"market_dominance\": 9.0134, // The percent of the total market cap that this asset represents\n      \"open\": 1561.07, // Open price for the time period\n      \"social_dominance\": 10.5694, // The percent of the total social volume that this topic represents\n      \"volume_24h\": 18231884427 // Volume in USD for 24 hours up to this data point\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/coins/:coin/meta/v1",
    "name": "Coins Meta",
    "description": "Get meta information for a cryptocurrency project. This includes information such as the website, social media links, and other information.",
    "parameters": [
      {
        "name": "coin",
        "description": "provide the numeric id or symbol of the coin or token.",
        "type": "string",
        "example": "2",
        "required": true
      }
    ],
    "changes": [
      {
        "date": "2024-04-01",
        "description": "New meta information endpoint for coins to get more detailed information about a cryptocurrency.",
        "type": "new"
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "sectionTitle": "coins",
    "score": 5,
    "exampleResponse": "{\n  \"data\": {\n    \"id\": 2, // LunarCrush internal ID for the asset\n    \"name\": \"Ethereum\", // The full name of the asset\n    \"symbol\": \"ETH\", // The symbol for the asset\n    \"market_categories\": \"layer-1\",\n    \"updated\": 1741059248, // Timestamp of when the data was last updated\n    \"blockchain\": [\n      {\n        \"type\": \"layer1\", // Type of item or social network of item e.g. tweet, youtube-video, tiktok, x, youtube, category, topic, creator/influencer\n        \"network\": \"ethereum\", // The social network for the post or influencer. We still refer to x as twitter out of developer preference.\n        \"address\": null,\n        \"decimals\": null\n      }\n    ],\n    \"short_summary\": \"Ethereum is open access to digital money and data-friendly services for everyone – no matter your background or location. It's a community-built technology behind the cryptocurrency ether (ETH) and thousands of applications you can use today.\",\n    \"description\": \"Ethereum is a technology that lets you send cryptocurrency to anyone for a small fee. It also powers applications that everyone can use and no one can take down.\\n\\nIt's the world's programmable blockchain.\\n\\nEthereum builds on Bitcoin's innovation, with some big differences.\\n\\nBoth let you use digital money without payment providers or banks. But Ethereum is programmable, so you can also use it for lots of different digital assets – even Bitcoin!\\n\\nThis also means Ethereum is for more than payments. It's a marketplace of financial services, games and apps that can't steal your data or censor you.\", // Explanation of the change and the potential impact\n    \"github_link\": \"https://github.com/ethereum\",\n    \"website_link\": \"https://www.ethereum.org/\",\n    \"whitepaper_link\": \"https://ethereum.org/en/whitepaper\",\n    \"twitter_link\": \"https://twitter.com/ethereum\",\n    \"reddit_link\": \"https://www.reddit.com/r/ethereum/\",\n    \"header_image\": \"headers/ethereum.png\",\n    \"header_text\": \"The foundation for our digital future\",\n    \"videos\": \"https://www.youtube.com/watch?v=GQR1xjQn5Pg\",\n    \"coingecko_link\": \"https://www.coingecko.com/en/coins/ethereum\",\n    \"coinmarketcap_link\": \"https://coinmarketcap.com/currencies/ethereum/\"\n  },\n  \"config\": { // This includes the inputs for the request processed by the server and may include additional hints about the request and response information.\n    \"coin\": \"2\",\n    \"generated\": 1781447091 // A unix timestamp (in seconds) when the data was generated to understand possibly stale data\n  }\n}"
  },
  {
    "endpoint": "/public/stocks/list/v2",
    "name": "Stocks List v2",
    "description": "Get a general snapshot of LunarCrush metrics on the entire list of tracked stocks. It is designed as a lightweight mechanism for monitoring the universe of available assets, either in aggregate or relative to each other. Metrics include Galaxy Score™, AltRank™, floor price, 24h percent change, market cap, social mentions, social interactions, social contributors, social dominance, and categories.",
    "parameters": [
      {
        "name": "sort",
        "description": "sort the output by metric",
        "type": "string",
        "default": "market_cap_rank",
        "options": [
          "id",
          "symbol",
          "name",
          "price",
          "volume_24h",
          "percent_change_24h",
          "market_cap",
          "market_cap_rank",
          "interactions_24h",
          "social_volume_24h",
          "social_dominance",
          "market_dominance",
          "galaxy_score",
          "galaxy_score_previous",
          "alt_rank",
          "alt_rank_previous"
        ]
      },
      {
        "name": "limit",
        "description": "limit the number of results. Default is 10 maximum is 100 per page.",
        "type": "number",
        "default": "10"
      },
      {
        "name": "desc",
        "description": "Pass any value as desc and the output will be reversed (descending)",
        "type": "boolean"
      },
      {
        "name": "page",
        "description": "When using limit, set the page of results to display, pages start at 0",
        "default": "0"
      }
    ],
    "changes": [
      {
        "date": "2024-01-03",
        "description": "v2 includes market and social data with options to sort and limit by metrics"
      },
      {
        "date": "2024-01-26",
        "description": "Logos now available for each entry"
      },
      {
        "date": "2024-09-13",
        "description": "Includes sentiment data"
      }
    ],
    "stale": 300,
    "ttl": 30,
    "publicApi": true,
    "upgradedApi": true,
    "sectionTitle": "stocks",
    "score": 6,
    "exampleResponse": "{\n  \"config\": { // This includes the inputs for the request processed by the server and may include additional hints about the request and response information.\n    \"limit\": 0,\n    \"sort\": \"market_cap_rank\",\n    \"desc\": true,\n    \"page\": 0,\n    \"total_rows\": 4070,\n    \"generated\": 1781447091 // A unix timestamp (in seconds) when the data was generated to understand possibly stale data\n  },\n  \"data\": [\n    {\n      \"id\": 7056, // LunarCrush internal ID for the asset\n      \"symbol\": \"NVDA\", // The symbol for the asset\n      \"name\": \"NVIDIA Corp.\", // The full name of the asset\n      \"price\": 205.19, // Current price in USD\n      \"volume_24h\": 0, // Volume in USD for 24 hours up to this data point\n      \"percent_change_24h\": 0.1562, // Percent change in price since 24 hours ago\n      \"market_cap\": 4969906990000, // Total dollar market value of all circulating supply or outstanding shares\n      \"market_cap_rank\": 1, // The rank of the asset by market cap with additional filtering to remove outliers and bad market data.\n      \"interactions_24h\": 83738789, // Number of interactions in the last 24 hours\n      \"social_volume_24h\": 22570, // Total number of posts with interactions on this topic in the last 24 hours\n      \"social_dominance\": 2.3184124267727846, // The percent of the total social volume that this topic represents\n      \"market_dominance\": 5.123529553620532, // The percent of the total market cap that this asset represents\n      \"market_dominance_prev\": 5.142913265949797,\n      \"galaxy_score\": 52.4, // A proprietary score based on technical indicators of price, average social sentiment, relative social activity, and a factor of how closely social indicators correlate with price and volume\n      \"galaxy_score_previous\": 76, // The galaxy score from the previous 24 hours\n      \"alt_rank\": 939, // A proprietary score based on how an asset is performing relative to all other assets supported\n      \"alt_rank_previous\": 405, // The alt rank from the previous 24 hours\n      \"sentiment\": 92, // % of posts (weighted by interactions) that are positive. 100% means all posts are positive, 50% is half positive and half negative, and 0% is all negative posts.\n      \"categories\": \"technology\", // an array of categories this topic aggregates into\n      \"topic\": \"nvda nvidia corp\", // LunarCrush social topic. Can only includes letters, numbers, spaces, #, and $\n      \"logo\": \"https://cdn.lunarcrush.com/stocks/nvda.png\" // The URL to the logo for the asset, topic, or category\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/stocks/list/v1",
    "name": "Stocks List",
    "description": "Lists all stocks supported by LunarCrush. Includes the \"topic\" endpoint to use to get social data from this asset as a social topic.",
    "parameters": [
      {
        "name": "sort",
        "description": "sort the output by metric",
        "type": "string",
        "default": "market_cap",
        "options": [
          "id",
          "symbol",
          "name",
          "price",
          "volume_24h",
          "percent_change_24h",
          "market_cap",
          "market_cap_rank",
          "interactions_24h",
          "social_volume_24h",
          "social_dominance",
          "market_dominance",
          "galaxy_score",
          "galaxy_score_previous",
          "alt_rank",
          "alt_rank_previous"
        ]
      },
      {
        "name": "limit",
        "description": "limit the number of results",
        "type": "number"
      },
      {
        "name": "desc",
        "description": "Pass any value as desc and the output will be reversed (descending)",
        "type": "boolean"
      },
      {
        "name": "page",
        "description": "When using limit, set the page of results to display"
      }
    ],
    "changes": [
      {
        "date": "2023-11-25",
        "description": "Includes the topic to use when looking up social data for this asset as a social topic"
      }
    ],
    "stale": 300,
    "ttl": 30,
    "publicApi": true,
    "sectionTitle": "stocks",
    "score": 6,
    "exampleResponse": "{\n  \"config\": { // This includes the inputs for the request processed by the server and may include additional hints about the request and response information.\n    \"sort\": \"market_cap_rank\",\n    \"desc\": true,\n    \"limit\": 0,\n    \"page\": 0,\n    \"total_rows\": 4070,\n    \"generated\": 1781447091 // A unix timestamp (in seconds) when the data was generated to understand possibly stale data\n  },\n  \"data\": [\n    {\n      \"id\": 7056, // LunarCrush internal ID for the asset\n      \"symbol\": \"NVDA\", // The symbol for the asset\n      \"name\": \"NVIDIA Corp.\", // The full name of the asset\n      \"price\": 205.19, // Current price in USD\n      \"volume_24h\": 0, // Volume in USD for 24 hours up to this data point\n      \"percent_change_24h\": 0.1562, // Percent change in price since 24 hours ago\n      \"market_cap\": 4969906990000, // Total dollar market value of all circulating supply or outstanding shares\n      \"market_cap_rank\": 1, // The rank of the asset by market cap with additional filtering to remove outliers and bad market data.\n      \"interactions_24h\": 83738789, // Number of interactions in the last 24 hours\n      \"social_volume_24h\": 22570, // Total number of posts with interactions on this topic in the last 24 hours\n      \"social_dominance\": 2.3184124267727846, // The percent of the total social volume that this topic represents\n      \"market_dominance\": 5.123529553620532, // The percent of the total market cap that this asset represents\n      \"market_dominance_prev\": 5.142913265949797,\n      \"galaxy_score\": 52.4, // A proprietary score based on technical indicators of price, average social sentiment, relative social activity, and a factor of how closely social indicators correlate with price and volume\n      \"galaxy_score_previous\": 76, // The galaxy score from the previous 24 hours\n      \"alt_rank\": 939, // A proprietary score based on how an asset is performing relative to all other assets supported\n      \"alt_rank_previous\": 405, // The alt rank from the previous 24 hours\n      \"sentiment\": 92, // % of posts (weighted by interactions) that are positive. 100% means all posts are positive, 50% is half positive and half negative, and 0% is all negative posts.\n      \"categories\": \"technology\", // an array of categories this topic aggregates into\n      \"topic\": \"nvda nvidia corp\", // LunarCrush social topic. Can only includes letters, numbers, spaces, #, and $\n      \"logo\": \"https://cdn.lunarcrush.com/stocks/nvda.png\" // The URL to the logo for the asset, topic, or category\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/stocks/:stock/v1",
    "name": "Stocks",
    "description": "Get market data on a stock. Specify the coin to be queried by providing the numeric ID or the symbol of the coin in the input parameter, which can be found by calling the /coins/list endpoint.",
    "parameters": [
      {
        "name": "stock",
        "description": "provide the numeric id or symbol of the stock.",
        "type": "string",
        "example": "7056",
        "required": true
      }
    ],
    "changes": [
      {
        "date": "2023-11-25",
        "description": "The stocks endpoint provides the current market data for a stock. Social data has been removed and is available using other endpoints"
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "pure_worker": "public_stocks_v1",
    "sectionTitle": "stocks",
    "score": 6,
    "exampleResponse": "{\n  \"config\": { // This includes the inputs for the request processed by the server and may include additional hints about the request and response information.\n    \"id\": \"stocks:7056\", // LunarCrush internal ID for the asset\n    \"_self_call\": true,\n    \"name\": \"NVIDIA Corp.\", // The full name of the asset\n    \"symbol\": \"NVDA\", // The symbol for the asset\n    \"topic\": \"$nvda\", // LunarCrush social topic. Can only includes letters, numbers, spaces, #, and $\n    \"generated\": 1781447091 // A unix timestamp (in seconds) when the data was generated to understand possibly stale data\n  },\n  \"data\": {\n    \"id\": 7056, // LunarCrush internal ID for the asset\n    \"name\": \"NVIDIA Corp.\", // The full name of the asset\n    \"symbol\": \"NVDA\", // The symbol for the asset\n    \"price\": 205.19, // Current price in USD\n    \"market_cap\": 4969906990000, // Total dollar market value of all circulating supply or outstanding shares\n    \"percent_change_24h\": 0.1562, // Percent change in price since 24 hours ago\n    \"volume_24h\": 0, // Volume in USD for 24 hours up to this data point\n    \"close\": 205.19, // Close price for the time period\n    \"market_cap_rank\": 1 // The rank of the asset by market cap with additional filtering to remove outliers and bad market data.\n  }\n}"
  },
  {
    "endpoint": "/public/stocks/:stock/time-series/v2",
    "name": "Stocks Time Series",
    "description": "Get market time series data on a stock. Specify the stock to be queried by providing the numeric ID or the symbol of the stock in the input parameter, which can be found by calling the /stocks/list endpoint.",
    "parameters": [
      {
        "name": "stock",
        "description": "provide the numeric id or symbol of the stock or token.",
        "type": "string",
        "example": "7056",
        "required": true
      },
      {
        "name": "bucket",
        "description": "bucket time series data into hours or days. default is hours.",
        "type": "string",
        "options": [
          "hour",
          "day"
        ],
        "default": "hour"
      },
      {
        "name": "interval",
        "description": "Use interval to specify the start and end time automatically for convenience. If \"start\" or \"end\" parameters are provided this parameter is ignored.",
        "options": [
          "1d",
          "1w",
          "1m",
          "3m",
          "6m",
          "1y",
          "all"
        ],
        "default": "1w",
        "type": "string"
      },
      {
        "name": "start",
        "description": "The start time (unix timestamp) to go back to.",
        "type": "timestamp"
      },
      {
        "name": "end",
        "description": "The end time (unix timestamp) to stop at.",
        "type": "timestamp"
      }
    ],
    "changes": [
      {
        "date": "2024-02-20",
        "description": "Introducing new stock time series endpoint v2 that includes market and social data combined."
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "pure_worker": "public_stocks_time_series_v2",
    "sectionTitle": "stocks",
    "score": 6,
    "exampleResponse": "{\n  \"config\": { // This includes the inputs for the request processed by the server and may include additional hints about the request and response information.\n    \"stock\": \"7056\",\n    \"topic\": \"$nvda\", // LunarCrush social topic. Can only includes letters, numbers, spaces, #, and $\n    \"id\": \"stocks:7056\", // LunarCrush internal ID for the asset\n    \"_self_call\": true,\n    \"name\": \"NVIDIA Corp.\", // The full name of the asset\n    \"symbol\": \"NVDA\", // The symbol for the asset\n    \"interval\": \"1w\", // Typically used for specifying time intervals like 1w = 1 week, 1m = 1 month etc\n    \"start\": 1780790400, // Start/from unix timestamp (in seconds)\n    \"end\": 1781454291, // End/to unix timestamp (in seconds)\n    \"bucket\": \"hour\", // Data is generally bucketed into hours or days\n    \"metrics\": [], // Comma separated list of metrics to include or that are included\n    \"generated\": 1781447091 // A unix timestamp (in seconds) when the data was generated to understand possibly stale data\n  },\n  \"data\": [\n    {\n      \"time\": 1780790400, // A unix timestamp (in seconds)\n      \"contributors_active\": 18470, // number of unique social accounts with posts that have interactions\n      \"contributors_created\": 193, // number of unique social accounts that created new posts\n      \"interactions\": 2927356, // number of all publicly measurable interactions on a social post (views, likes, comments, thumbs up, upvote, share etc)\n      \"posts_active\": 28653, // number of unique social posts with interactions\n      \"posts_created\": 276, // number of unique social posts created\n      \"sentiment\": 76, // % of posts (weighted by interactions) that are positive. 100% means all posts are positive, 50% is half positive and half negative, and 0% is all negative posts.\n      \"spam\": 2518, // The number of posts created that are considered spam\n      \"alt_rank\": 428, // A proprietary score based on how an asset is performing relative to all other assets supported\n      \"close\": 205.1, // Close price for the time period\n      \"galaxy_score\": 51, // A proprietary score based on technical indicators of price, average social sentiment, relative social activity, and a factor of how closely social indicators correlate with price and volume\n      \"high\": 205.1, // Higest price fo rthe time period\n      \"low\": 205.1, // Lowest price for the time period\n      \"market_cap\": 4967727100000, // Total dollar market value of all circulating supply or outstanding shares\n      \"market_dominance\": 5.2955, // The percent of the total market cap that this asset represents\n      \"open\": 205.1, // Open price for the time period\n      \"social_dominance\": 2.9259 // The percent of the total social volume that this topic represents\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/searches/search",
    "name": "Searches Search",
    "description": "Get recently popular social posts matching a single search term or phrase. Optionally configure and test a custom search configuration.",
    "parameters": [
      {
        "name": "term",
        "description": "Test a single search term or phrase",
        "type": "string",
        "example": "lunarcrush"
      },
      {
        "name": "search_json",
        "description": "A JSON object (stringified) that defines the search criteria for the custom search aggregation. Posts that match any of the search term will be included. For each search term there are optional inclusion and exclusion terms to help fine tune the results.",
        "type": "string",
        "example": ""
      }
    ],
    "changes": [
      {
        "date": "2024-09-09",
        "description": "New searches/search endpoint added to test a search configuration against matching posts.",
        "type": "new"
      }
    ],
    "development": true,
    "upgradedApi": true,
    "publicApi": true,
    "sectionTitle": "searches",
    "score": 8,
    "exampleResponse": "{\n  \"error\": \"Error: search_json object requires at least 1 valid search term\"\n}"
  },
  {
    "endpoint": "/public/searches/list",
    "name": "Searches List",
    "description": "List all custom search aggregations.",
    "parameters": [],
    "changes": [
      {
        "date": "2024-09-09",
        "description": "New searches/list endpoint added to fetch a list of all custom search aggregations.",
        "type": "new"
      }
    ],
    "development": true,
    "upgradedApi": true,
    "publicApi": true,
    "user": true,
    "sectionTitle": "searches",
    "score": 8,
    "exampleResponse": "{\n  \"data\": [\n    {\n      \"id\": \"lc1s5M27Jq\", // LunarCrush internal ID for the asset\n      \"name\": \"Pump.fun Leaderboard\", // The full name of the asset\n      \"search_json\": {\n        \"terms\": [],\n        \"rollups\": [\n          \"solanatqj8yfmagrg7oorpqkvgyr52r96rftamvwfth9bpump\"\n        ]\n      },\n      \"priority\": true,\n      \"created\": 1749064987\n    }\n  ]\n}"
  },
  {
    "endpoint": "/public/searches/create",
    "name": "Searches Create",
    "description": "Create a custom search aggregation of topics and search terms. Fine tune the posts that get included or excluded. Search terms and configuration cannot be changed once created. If successful returns the new id/slug and the processed search config. Note that search terms will be adjusted and simplified for optimized search and matching.",
    "parameters": [
      {
        "name": "name",
        "description": "The name of the custom search aggregation.",
        "type": "string",
        "required": true
      },
      {
        "name": "search_json",
        "description": "A JSON object (stringified) that defines the search criteria for the custom search aggregation. Search terms and configuration cannot be changed once created. Posts that match any of the search term will be included. For each search term there are optional inclusion and exclusion terms to help fine tune the results.",
        "type": "string",
        "example": "",
        "required": true
      },
      {
        "name": "priority",
        "description": "Flag as a high priority search aggregation. Pro accounts get up to 10 high priority search aggregations at a time.",
        "type": "boolean"
      }
    ],
    "changes": [
      {
        "date": "2024-09-09",
        "description": "New searches/create endpoint added to allow the creation of custom search aggregations.",
        "type": "new"
      }
    ],
    "development": true,
    "upgradedApi": true,
    "publicApi": true,
    "user": true,
    "sectionTitle": "searches",
    "score": 8,
    "exampleResponse": "{\n  \"error\": \"Error: name is required\"\n}"
  },
  {
    "endpoint": "/public/searches/:slug/update",
    "name": "Searches Update",
    "description": "Update a custom search aggregation name or priority. Search terms and configuration cannot be changed once created.",
    "parameters": [
      {
        "name": "slug",
        "description": "The ID of the custom search aggregation to update.",
        "type": "string",
        "required": true
      },
      {
        "name": "name",
        "description": "The name of the custom search aggregation.",
        "type": "string"
      },
      {
        "name": "search_json",
        "description": "A JSON object (stringified) that defines the search criteria for the custom search aggregation. Search terms and configuration cannot be changed once created. Posts that match any of the search term will be included. For each search term there are optional inclusion and exclusion terms to help fine tune the results.",
        "type": "string",
        "example": "",
        "required": true
      },
      {
        "name": "priority",
        "description": "Define if this is a high priority search aggregation. Pro accounts get up to 10 high priority search aggregations at a time.",
        "type": "boolean"
      }
    ],
    "changes": [
      {
        "date": "2024-10-11",
        "description": "Updating the search criteria on a custom search aggregation is now supported.",
        "type": "new"
      },
      {
        "date": "2024-09-09",
        "description": "New searches/:slug/update endpoint added to allow renaming and adjusting priority of custom search aggregations.",
        "type": "new"
      }
    ],
    "development": true,
    "upgradedApi": true,
    "publicApi": true,
    "user": true,
    "sectionTitle": "searches",
    "score": 8,
    "exampleResponse": "{\n  \"error\": \"Error: search_json is required\"\n}"
  },
  {
    "endpoint": "/public/searches/:slug/delete",
    "name": "Searches Delete",
    "description": "Delete a custom search aggregation.",
    "parameters": [
      {
        "name": "slug",
        "description": "The ID of the custom search aggregation to delete.",
        "type": "string",
        "required": true
      }
    ],
    "changes": [
      {
        "date": "2024-09-09",
        "description": "New searches/:slug/delete endpoint added to allow the deletion of custom search aggregations.",
        "type": "new"
      }
    ],
    "development": true,
    "upgradedApi": true,
    "publicApi": true,
    "user": true,
    "sectionTitle": "searches",
    "score": 8,
    "exampleResponse": "{\n  \"error\": \"Error: That item does not exist\"\n}"
  },
  {
    "endpoint": "/public/searches/:slug",
    "name": "Searches",
    "description": "See the summary output of a custom search aggregation.",
    "parameters": [
      {
        "name": "slug",
        "description": "The ID of the custom search aggregation to view.",
        "type": "string",
        "required": true
      }
    ],
    "changes": [
      {
        "date": "2024-09-09",
        "description": "New searches/:slug endpoint added to fetch the latest data in a custom search aggregation.",
        "type": "new"
      },
      {
        "date": "2025-06-04",
        "description": "This endpoint will be removed, use the topics endpoints with the custom search slug as the topic ID to get the latest data"
      }
    ],
    "development": true,
    "upgradedApi": true,
    "publicApi": true,
    "user": true,
    "sectionTitle": "searches",
    "score": 8,
    "exampleResponse": "{\n  \"error\": \"Use the topics endpoints to get the latest data like /public/topic/:slug/v1\"\n}"
  },
  {
    "endpoint": "/public/system/changes",
    "name": "System Changes",
    "description": "Updates to potential changes to historical time series data. Search term changes only impact the most recent 72 hours (hourly) or 3 days (daily) data. \"full historical\" is a change that may impact the full history of data. Each change provides a description of what is impacted and why.",
    "parameters": [],
    "changes": [
      {
        "date": "2024-08-02",
        "description": "Introducing public/system/changes endpoint to get a history of changes that may impact historical time series data for all time series endpoints.",
        "type": "new"
      }
    ],
    "stale": true,
    "ttl": 30,
    "publicApi": true,
    "development": true,
    "sectionTitle": "systems",
    "score": 10,
    "exampleResponse": "{\n  \"data\": [\n    {\n      \"asset_type\": \"coins\", // One of coins, nfts, stocks, topic or category\n      \"asset_id\": 162898, // The id of the asset (coin, nft, stock, topic, or category)\n      \"asset_name\": \"Woke Mind Virus (WOKE)\", // The descriptive name of the asset to help identify it\n      \"change\": \"search terms established\", // The type of change that occurred\n      \"description\": \"search criteria initially set for this asset for the purposes of tracking changes over time\", // Explanation of the change and the potential impact\n      \"time\": 1781436504 // A unix timestamp (in seconds)\n    }\n  ]\n}"
  }
]