LunarCrush API v4

This documentation is available as JSON, OpenAPI v3, and markdown.

/public/categories/list/v1

Get a list of trending social categories.

parameters

/public/category/:category/creators/v1

Get the top creators for a social category

parameters

name description type example required
category Provide the category to get details for. A category must be all lower case and can only include letters, numbers, and spaces. string musicians true

/public/category/:category/news/v1

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 description type example required
category Provide the category to get details for. A category must be all lower case and can only include letters, numbers, and spaces. string cryptocurrencies true

/public/category/:category/posts/v1

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 description type example required
category Provide the category to get details for. A category must be all lower case and can only include letters, numbers, and spaces. string cryptocurrencies true
start 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. timestamp
end (Optional) The end time (unix timestamp) to stop at. Will be rounded to the end of the day. timestamp

/public/category/:category/time-series/v1

Get historical time series data for a social category

parameters

name description type example required options default
category Provide the category to get details for. A category must be all lower case and can only include letters, numbers, and spaces. string cryptocurrencies true
bucket bucket time series data into hours or days. default is hours. string hour,day hour
interval Use interval to specify the start and end time automatically for convenience. If "start" or "end" parameters are provided this parameter is ignored. string 1d,1w,1m,3m,6m,1y,all 1w
start The start time (unix timestamp) to go back to. timestamp
end The end time (unix timestamp) to stop at. timestamp

/public/category/:category/topics/v1

Get the top topics for a social category

parameters

name description type example required
category Provide the topic to get details for. A topic must be all lower case and can only include letters, numbers, spaces, # and $. string musicians true

/public/category/:category/v1

Get summary information for a social category

parameters

name description type example required
category 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. string musicians true

/public/coins/:coin/meta/v1

Get meta information for a cryptocurrency project. This includes information such as the website, social media links, and other information.

parameters

name description type example required
coin provide the numeric id or symbol of the coin or token. string 2 true

/public/coins/:coin/time-series/v1

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 description type example required
coin provide the numeric id or symbol of the coin or token. string 2 true

/public/coins/:coin/time-series/v2

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 description type example required options default
coin provide the numeric id or symbol of the coin or token. string 2 true
bucket bucket time series data into hours or days. default is hours. string hour,day hour
interval Use interval to specify the start and end time automatically for convenience. If "start" or "end" parameters are provided this parameter is ignored. string 1d,1w,1m,3m,6m,1y,all 1w
start The start time (unix timestamp) to go back to. timestamp
end The end time (unix timestamp) to stop at. timestamp

/public/coins/:coin/v1

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 description type example required
coin provide the numeric id or symbol of the coin or token. string 2 true

/public/coins/list/v1

Lists all coins and tokens supported by LunarCrush. Includes the "topic" endpoint to use to get social data from this asset as a social topic.

parameters

/public/coins/list/v2

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 description type default options
sort sort the output by metric string market_cap_rank 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
filter 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 string
limit limit the number of results. Default is 10 maximum is 100 per page. number 10
desc Pass any value as desc and the output will be reversed (descending) boolean
page When using limit, set the page of results to display, pages start at 0 0

/public/creator/:network/:id/posts/v1

Get the top posts for a specific creator.

parameters

name description type example required
network Network for the creator. One of twitter, youtube, instagram, reddit, or tiktok string twitter true
id Unique ID or screen name of the creator string elonmusk true
start 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. timestamp
end (Optional) The end time (unix timestamp) to stop at. Will be rounded to the end of the day. timestamp

/public/creator/:network/:id/time-series/v1

Get time series data on a creator.

parameters

name description type example required options default
network Influencer social network string twitter true
id The unique id or screen name of the creator string lunarcrush true
bucket bucket time series data into hours or days. default is hours. string hour,day hour
interval Use interval to specify the start and end time automatically for convenience. If "start" or "end" parameters are provided this parameter is ignored. string 1d,1w,1m,3m,6m,1y,all 1w
start The start time (unix timestamp) to go back to. timestamp
end The end time (unix timestamp) to stop at. timestamp

/public/creator/:network/:id/v1

Get detail information on a specific creator

parameters

name description type example required
network Provide the network for the creator. One of twitter, youtube, instagram, reddit, or tiktok string twitter true
id Provide the unique ID or screen name of the creator string elonmusk true

/public/creators/list/v1

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

/public/nfts/:nft/time-series/v1

Get market time series data on an nft collection. Specify the nft to be queried by providing the numeric ID or slug of the nft collection in the input parameter, which can be found by calling the /public/nfts/list endpoint.

parameters

name description type example required
nft provide the numeric id or symbol of the nft collection. string 2 true

/public/nfts/:nft/time-series/v2

Get market time series data on a nft. Specify the nft to be queried by providing the numeric ID or the symbol of the nft in the input parameter, which can be found by calling the /nfts/list endpoint.

parameters

name description type example required options default
nft provide the numeric id or symbol of the nft or token. string 2 true
bucket bucket time series data into hours or days. default is hours. string hour,day hour
interval Use interval to specify the start and end time automatically for convenience. If "start" or "end" parameters are provided this parameter is ignored. string 1d,1w,1m,3m,6m,1y,all 1w
start The start time (unix timestamp) to go back to. timestamp
end The end time (unix timestamp) to stop at. timestamp

/public/nfts/:nft/v1

Get market data on an nft collection. Specify the nft to be queried by providing the numeric ID or the slug of the nft in the input parameter, which can be found by calling the /public/nfts/list endpoint.

parameters

name description type example required
nft provide the numeric id or slug of the nft. string 2 true

/public/nfts/list/v1

Lists all nft collections supported by LunarCrush. Includes the "topic" endpoint to use to get social data from this nft collection as a social topic.

parameters

/public/nfts/list/v2

Get a general snapshot of LunarCrush metrics on the entire list of tracked NFTS. 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 description type default options
sort sort the output by metric string market_cap_rank id,symbol,name,floor_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
limit limit the number of results. Default is 10 maximum is 100 per page. number 10
desc Pass any value as desc and the output will be reversed (descending) boolean
page When using limit, set the page of results to display, pages start at 0 0

/public/posts/:post_type/:post_id/time-series/v1

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 description type example required
post_type The post type e.g. tweet, youtube-video, tiktok-video, reddit-post, instagram-post string tweet true
post_id 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 string 1756378079893782591 true

/public/posts/:post_type/:post_id/v1

Get details of a post

parameters

name description type example required
post_type The post type e.g. tweet, youtube-video, tiktok-video, reddit-post, instagram-post string tweet true
post_id 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 string 1756378079893782591 true

/public/searches/:slug

See the summary output of a custom search aggregation.

parameters

name description type required
slug The ID of the custom search aggregation to view. string true

/public/searches/:slug/delete

Delete a custom search aggregations.

parameters

name description type required
slug The ID of the custom search aggregation to delete. string true

/public/searches/:slug/update

Update a custom search aggregation name or priority. Search terms and configuration cannot be changed once created.

parameters

name description type required example
slug The ID of the custom search aggregation to update. string true
name The name of the custom search aggregation. string
search_json 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. string true
priority Define if this is a high priority search aggregation. Pro accounts get up to 10 high priority search aggregations at a time. boolean

/public/searches/create

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 description type required example
name The name of the custom search aggregation. string true
search_json 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. string true
priority Flag as a high priority search aggregation. Pro accounts get up to 10 high priority search aggregations at a time. boolean

/public/searches/list

List all custom search aggregations.

parameters

/public/searches/search

Get recently popular social posts matching a single search term or phrase. Optionally configure and test a custom search configuration.

parameters

name description type example
term Test a single search term or phrase string lunarcrush
search_json 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. string

/public/stocks/:stock/time-series/v1

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 description type example required
stock provide the numeric id or symbol of the stock. string 7056 true

/public/stocks/:stock/time-series/v2

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 description type example required options default
stock provide the numeric id or symbol of the stock or token. string 7056 true
bucket bucket time series data into hours or days. default is hours. string hour,day hour
interval Use interval to specify the start and end time automatically for convenience. If "start" or "end" parameters are provided this parameter is ignored. string 1d,1w,1m,3m,6m,1y,all 1w
start The start time (unix timestamp) to go back to. timestamp
end The end time (unix timestamp) to stop at. timestamp

/public/stocks/:stock/v1

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 description type example required
stock provide the numeric id or symbol of the stock. string 7056 true

/public/stocks/list/v1

Lists all stocks supported by LunarCrush. Includes the "topic" endpoint to use to get social data from this asset as a social topic.

parameters

/public/stocks/list/v2

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 description type default options
sort sort the output by metric string market_cap_rank 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
limit limit the number of results. Default is 10 maximum is 100 per page. number 10
desc Pass any value as desc and the output will be reversed (descending) boolean
page When using limit, set the page of results to display, pages start at 0 0

/public/system/changes

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

/public/topic/:topic/creators/v1

Get the top creators for a social topic

parameters

name description type example required
topic Provide the topic to get details for. A topic must be all lower case and can only include letters, numbers, spaces, # and $. string bitcoin true

/public/topic/:topic/news/v1

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 description type example required
topic Provide the topic to get details for. A topic must be all lower case and can only include letters, numbers, spaces, # and $. string bitcoin true

/public/topic/:topic/posts/v1

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 description type example required
topic Provide the topic to get details for. A topic must be all lower case and can only include letters, numbers, spaces, # and $. string bitcoin true
start 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. timestamp
end (Optional) The end time (unix timestamp) to stop at. Will be rounded to the end of the day. timestamp

/public/topic/:topic/time-series/v1

Get historical time series data for a social topic

parameters

name description type example required options default
topic Provide the topic to get details for. A topic must be all lower case and can only include letters, numbers, spaces, # and $. string bitcoin true
bucket bucket time series data into hours or days. default is hours. string hour,day hour
interval Use interval to specify the start and end time automatically for convenience. If "start" or "end" parameters are provided this parameter is ignored. string 1d,1w,1m,3m,6m,1y,all 1w
start The start time (unix timestamp) to go back to. timestamp
end The end time (unix timestamp) to stop at. timestamp

/public/topic/:topic/time-series/v2

Get historical time series data for a social topic

parameters

name description type example required options default
topic Provide the topic to get details for. A topic must be all lower case and can only include letters, numbers, spaces, # and $. string bitcoin true
bucket 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. string ,hour,day latest

/public/topic/:topic/v1

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 description type example required
topic 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. string bitcoin true

/public/topic/:topic/whatsup/v1

Generate an AI summary of the hottest news and social posts for a specific topic

parameters

name description type example required
topic Provide the topic to get a summary for. A topic must be all lower case and can only include letters, numbers, spaces, # and $. string bitcoin true

/public/topics/list/v1

Get a list of trending social topics.

parameters

/storm/test-workers

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 description type example required
topic 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. string bitcoin true