### LunarCrush Categories List and Detail API Endpoints Source: https://lunarcrush.ai/index This section documents the LunarCrush API endpoints for retrieving lists of categorized topics and their detailed information. It outlines the URL structure, available sorting metrics for different category types (cryptocurrencies/stocks vs. others), and provides concrete usage examples. ```APIDOC Categories List API: Endpoint: /list/{category}/{sort}/{limit} category: Type: string Description: The URL-friendly slug of the category (e.g., 'cryptocurrencies', 'automotive-brands'). sort: Type: string Description: The metric to sort the results by. Available for Cryptocurrencies & Stocks: - alt_rank - galaxy_score - close - percent_change_1h - percent_change_24h - percent_change_7d - interactions - posts_active - contributors_active - sentiment - social_dominance - market_cap - market_dominance - volume - circulating_supply - topic_rank Available for All Other Categories: - interactions - posts_active - contributors_active - sentiment limit: Type: integer (optional) Description: Limits the number of rows returned, up to a maximum of 1000. Categories Detail API: Endpoint: /topic/_{category_slug} category_slug: Type: string Description: The category slug prefixed with an underscore (e.g., '_cryptocurrencies'). Usage Examples: - Top Automotive Brands by unique Creators: /list/automotive-brands/contributors_active - Top NFL Teams by # Mentions: /list/nfl/posts_active - Top 10 Cryptocurrencies by AltRank™: /list/cryptocurrencies/alt_rank/10 - Top 100 Stocks by Price % Change: /list/stocks/percent_change_24h/100 - Cryptocurrencies Detail: /topic/_cryptocurrencies - Stocks Detail: /topic/_stocks ``` -------------------------------- ### Topic Posts v1 Endpoint Source: https://lunarcrush.ai/index Retrieves the top posts for a social topic. If a start time is provided, results are top posts by interactions within that time range. If no start time is given, it returns the most recent top posts by interactions from the last 24 hours. ```APIDOC Endpoint: Topic Posts Path: /public/topic/:topic/posts/v1 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. ``` -------------------------------- ### LunarCrush Public API Endpoint Reference Source: https://lunarcrush.ai/index Detailed documentation for the LunarCrush Public API endpoints. Each entry specifies the endpoint path and a description of the data it provides, covering categories, coins, creators, posts, and search functionalities. ```APIDOC LunarCrush API Documentation Base URL: https://lunarcrush.com/api4 Authentication: - Access requires a LunarCrush account and plan subscription. - API keys are managed in the Authentication section of the developer documentation. Endpoints: Categories List: Path: /public/categories/list/v1 Description: Get a list of trending social categories. Category Creators: Path: /public/category/:category/creators/v1 Description: Get the top creators for a social category. Category News: Path: /public/category/:category/news/v1 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. Category Posts: Path: /public/category/:category/posts/v1 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. Category Time Series: Path: /public/category/:category/time-series/v1 Description: Get historical time series data for a social category. Category Topics: Path: /public/category/:category/topics/v1 Description: Get the top topics for a social category. Category: Path: /public/category/:category/v1 Description: Get summary information for a social category. Coins Meta: Path: /public/coins/:coin/meta/v1 Description: Get meta information for a cryptocurrency project. This includes information such as the website, social media links, and other information. Coins Time Series: Path: /public/coins/:coin/time-series/v2 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. Coins: Path: /public/coins/:coin/v1 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. Coins List: Path: /public/coins/list/v1 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. Coins List v2: Path: /public/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. Creator Posts: Path: /public/creator/:network/:id/posts/v1 Description: Get the top posts for a specific creator. Creator Time Series: Path: /public/creator/:network/:id/time-series/v1 Description: Get time series data on a creator. Creator: Path: /public/creator/:network/:id/v1 Description: Get detail information on a specific creator. Creators List: Path: /public/creators/list/v1 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. Posts Time Series: Path: /public/posts/:post_type/:post_id/time-series/v1 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. Posts: Path: /public/posts/:post_type/:post_id/v1 Description: Get details of a post. Searches: Path: /public/searches/:slug Description: See the summary output of a custom search aggregation. ``` -------------------------------- ### Topic Whatsup v1 Endpoint Source: https://lunarcrush.ai/index Generates an AI-powered summary of the hottest news and social posts for a specific topic, providing a concise overview of trending content. ```APIDOC Endpoint: Topic Whatsup Path: /public/topic/:topic/whatsup/v1 Description: Generate an AI summary of the hottest news and social posts for a specific topic ``` -------------------------------- ### API Reference for LunarCrush Metrics Source: https://lunarcrush.ai/index This section details the various metrics available through the LunarCrush API, including their display names, corresponding API keys, and a brief explanation of what each metric represents. These keys are used in API requests and responses. ```APIDOC AltRank™ [alt_rank]: AltRank™ evaluates both market and social data. This ranking system assesses an asset's price movement alongside its social activity indicators, offering a comprehensive view of its current standing in the crypto market. ``` ```APIDOC Galaxy Score™ [galaxy_score]: Galaxy Score™ assesses the health of an asset against itself. It evaluates an asset's performance by analyzing a combination of market and social indicators, providing a comprehensive view of its current standing. ``` ```APIDOC Price [close]: Price calculates the amount of money expected, required, or given in payment for an asset. ``` ```APIDOC 1h % [percent_change_1h]: Percentage change in price over the last hour. ``` ```APIDOC 24h % [percent_change_24h]: Percentage change in price over the last 24 hours. ``` ```APIDOC 7d % [percent_change_7d]: Percentage change in price over the last 7 days. ``` ```APIDOC Engagements [interactions]: LunarCrush monitors social engagements by aggregating and analyzing data from various social media platforms. Engagements tracked include views, likes, comments, retweets, and upvotes. ``` ```APIDOC Mentions [posts_active]: Mentions measure the number of total posts that mention specific assets or topics over the last 24-hour timeframe. Mentions are measured continuously to monitor trends over longer timeframes. ``` ```APIDOC Creators [contributors_active]: Creators measures the unique number of creators that have posts that are active and have received engagements. ``` ```APIDOC Sentiment [sentiment]: Sentiment is the % of posts that are positive weighted by engagements. A score of 100% means all posts were positive and 0% means all posts were negative. ``` ```APIDOC Social Dominance [social_dominance]: Social Dominance measures the "share of voice" across social media data of an asset relative to the categories that asset resides in and is calculated on a rolling 24-hour timeframe. ``` ```APIDOC Market Cap [market_cap]: Market Capitalization shows how much a company, coin, or token is worth as determined by the total market value of all outstanding shares, coins, or tokens. ``` ```APIDOC Market Dominance [market_dominance]: Market Dominance tracks the relative market cap of an asset vs. the entire market. Market Dominance is calculated as a relative percentage of 100%. ``` ```APIDOC Trading Volume [volume]: Trading Volume is the number of shares, coins, or tokens traded in a particular period of time. ``` ```APIDOC Circulating Supply [circulating_supply]: 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. ``` ```APIDOC TopicRank™ [topic_rank]: TopicRank™ ranks every topic on LunarCrush based on the number of engagements and mentions over the last 24 hours. Topics are tracked across all categories as well as topics that do not reside in any category at all. ``` ```APIDOC CreatorRank™ [influencer_rank]: CreatorRank™ tracks the relative ranking of a creator based on all tracked creators overall or within a specific category or topic. ``` ```APIDOC Followers [followers]: The number of followers on of the creator account. ``` -------------------------------- ### Topic v1 Endpoint Source: https://lunarcrush.ai/index Provides summary information for a social topic. The output includes a 24-hour aggregation of social activity, with metrics comparing the latest 24 hours to the preceding 24 hours. ```APIDOC Endpoint: Topic Path: /public/topic/:topic/v1 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. ``` -------------------------------- ### Searches Create Endpoint Source: https://lunarcrush.ai/index Creates a new custom search aggregation, allowing users to define topics and search terms for fine-tuning post inclusions or exclusions. Once created, search terms and configuration are immutable. A successful creation returns the new ID/slug and the processed search configuration, with terms potentially adjusted for optimization. ```APIDOC Endpoint: Searches Create Path: /public/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. ``` -------------------------------- ### Topic Creators v1 Endpoint Source: https://lunarcrush.ai/index Retrieves a list of the top creators associated with a specific social topic. ```APIDOC Endpoint: Topic Creators Path: /public/topic/:topic/creators/v1 Description: Get the top creators for a social topic ``` -------------------------------- ### Stocks v1 Endpoint Source: https://lunarcrush.ai/index Provides general market data for a specific stock. The stock (referred to as 'coin' in the description) can be identified by its numeric ID or symbol, available via the /coins/list endpoint. ```APIDOC Endpoint: Stocks Path: /public/stocks/:stock/v1 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. ``` -------------------------------- ### Stocks List v2 Endpoint Source: https://lunarcrush.ai/index Provides a general snapshot of LunarCrush metrics for the entire list of tracked stocks. This endpoint is optimized for monitoring the universe of available assets, offering metrics such as Galaxy Score™, AltRank™, floor price, 24h percent change, market cap, social mentions, social interactions, social contributors, social dominance, and categories. ```APIDOC Endpoint: Stocks List v2 Path: /public/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. ``` -------------------------------- ### Stocks List v1 Endpoint Source: https://lunarcrush.ai/index Lists all stocks supported by LunarCrush. Each entry includes a 'topic' endpoint, which can be used to retrieve social data related to that asset as a social topic. ```APIDOC Endpoint: Stocks List Path: /public/stocks/list/v1 Description: Lists all stocks supported by LunarCrush. Includes the "topic" endpoint to use to get social data from this asset as a social topic. ``` -------------------------------- ### Topics List v1 Endpoint Source: https://lunarcrush.ai/index Retrieves a list of currently trending social topics, providing insights into popular discussions. ```APIDOC Endpoint: Topics List Path: /public/topics/list/v1 Description: Get a list of trending social topics. ``` -------------------------------- ### Searches List Endpoint Source: https://lunarcrush.ai/index Retrieves a list of all custom search aggregations currently configured by the user. ```APIDOC Endpoint: Searches List Path: /public/searches/list Description: List all custom search aggregations. ``` -------------------------------- ### Retrieve Top Creators by Topic Source: https://lunarcrush.ai/index This API endpoint enables fetching a list of top social media creators associated with a specific topic. Users can specify the topic slug, a sorting parameter, and a limit for the number of results. This allows for granular analysis of creators influencing discussions around particular topics. ```APIDOC /list/creators/{topic}/{sort}/{limit} Parameters: topic: The slug of the topic (e.g., bitcoin, ethereum). sort: The parameter to sort by (e.g., mentions). limit: The maximum number of creators to return (e.g., 10, 100). Examples: /list/creators/bitcoin /list/creators/ethereum/mentions/100 ``` -------------------------------- ### Retrieve Top Creators by Category Source: https://lunarcrush.ai/index This API endpoint allows fetching a list of top social media creators associated with a specific category. Users can specify the category slug, a sorting parameter, and a limit for the number of results. This helps in understanding the most influential creators within a defined category. ```APIDOC /list/creators/_{category}/{sort}/{limit} Parameters: _category: The slug of the category, prefixed with an underscore (e.g., _cryptocurrencies, _stocks). sort: The parameter to sort by (e.g., mentions). limit: The maximum number of creators to return (e.g., 10, 100). Examples: /list/creators/_cryptocurrencies /list/creators/_stocks/mentions/100 ``` -------------------------------- ### Searches Search Endpoint Source: https://lunarcrush.ai/index Fetches recently popular social posts that match a specified single search term or phrase. This endpoint also supports optional configuration and testing of custom search settings. ```APIDOC Endpoint: Searches Search Path: /public/searches/search Description: Get recently popular social posts matching a single search term or phrase. Optionally configure and test a custom search configuration. ``` -------------------------------- ### System Changes Endpoint Source: https://lunarcrush.ai/index Provides updates regarding potential changes to historical time series data. It specifies that search term changes only affect the most recent 72 hours (hourly) or 3 days (daily) of data, while 'full historical' changes may impact the entire data history. Each change entry includes a description of what is impacted and the reason. ```APIDOC Endpoint: System Changes Path: /public/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. ``` -------------------------------- ### Stocks Time Series v2 Endpoint Source: https://lunarcrush.ai/index Retrieves market time series data for a specific stock. The stock can be identified by its numeric ID or symbol, which can be obtained from the /stocks/list endpoint. ```APIDOC Endpoint: Stocks Time Series Path: /public/stocks/:stock/time-series/v2 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. ``` -------------------------------- ### Topic News v1 Endpoint Source: https://lunarcrush.ai/index Fetches the top news posts relevant to a social topic. The ranking of news posts is determined by metrics related to social posts that mention them. ```APIDOC Endpoint: Topic News Path: /public/topic/:topic/news/v1 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. ``` -------------------------------- ### Topic Time Series v2 Endpoint Source: https://lunarcrush.ai/index Retrieves historical time series data for a specified social topic, offering an updated version of the time series data retrieval. ```APIDOC Endpoint: Topic Time Series v2 Path: /public/topic/:topic/time-series/v2 Description: Get historical time series data for a social topic ``` -------------------------------- ### Topic Time Series v1 Endpoint Source: https://lunarcrush.ai/index Retrieves historical time series data for a specified social topic. ```APIDOC Endpoint: Topic Time Series Path: /public/topic/:topic/time-series/v1 Description: Get historical time series data for a social topic ``` -------------------------------- ### Searches Update Endpoint Source: https://lunarcrush.ai/index Updates the name or priority of a custom search aggregation. Note that the search terms and configuration for an aggregation cannot be modified after creation. ```APIDOC Endpoint: Searches Update Path: /public/searches/:slug/update Description: Update a custom search aggregation name or priority. Search terms and configuration cannot be changed once created. ``` -------------------------------- ### Searches Delete Endpoint Source: https://lunarcrush.ai/index Deletes an existing custom search aggregation based on its slug. This operation permanently removes the specified search configuration. ```APIDOC Endpoint: Searches Delete Path: /public/searches/:slug/delete Description: Delete a custom search aggregation. ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.