### GET /public/coins/list/v1

Source: https://lunarcrush.com/developers/api/index

This endpoint is a placeholder example for fetching lists of coins, stocks, news, creators, and categories. The actual functionality depends on the specific data being queried.

```APIDOC
## GET /public/coins/list/v1

### Description
This is a sample endpoint used to illustrate fetching various types of data, such as top mentioned cryptocurrencies, top creators, top news, and categories. The exact data returned depends on the context of the query.

### Method
`GET`

### Endpoint
`/public/coins/list/v1`

### Parameters
*This endpoint may have various query parameters depending on the specific data being requested. The examples below assume common use cases.*

#### Query Parameters
- **type** (string) - Optional - Specifies the type of data to retrieve (e.g., 'coins', 'creators', 'news', 'categories').
- **limit** (integer) - Optional - The number of results to return.
- **time_frame** (string) - Optional - The time period for the data (e.g., '24h', '7d', '30d').

### Request Example
```json
{
  "example": "GET https://lunarcrush.com/api4/public/coins/list/v1?type=coins&limit=10&time_frame=24h"
}
```

### Response
#### Success Response (200)
- **data** (array) - An array of objects containing the requested data.
- **status** (string) - The status of the response.

#### Response Example
```json
{
  "example": "{
    \"data\": [
      {
        \"coin_id\": \"bitcoin\",
        \"name\": \"Bitcoin\",
        \"symbol\": \"BTC\",
        \"social_score\": 100
      }
    ],
    \"status\": \"success\"\n  }"
}
```
```

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

### API Overview

Source: https://lunarcrush.com/developers/api/index

Information on getting started with the LunarCrush API, including subscription requirements, API keys, and base URL. The API supports GitHub markdown, JSON, and OpenAPI v3 outputs.

```APIDOC
## API Overview

### Description
Access real-time social data and insights from LunarCrush. Requires a subscription and API key.

### Base URL
`https://lunarcrush.com/api4`

### Supported Outputs
- GitHub Markdown
- JSON
- OpenAPI v3
```

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

### Get Category List

Source: https://lunarcrush.com/developers/api/overview

Fetches a list of all available categories.

```APIDOC
## GET /categories/list

### Description
Retrieves a list of all available categories on LunarCrush.

### Method
GET

### Endpoint
https://lunarcrush.com/api4/categories/list

### Parameters

#### Query Parameters
None

#### Request Body
None

### Request Example
```
GET https://lunarcrush.com/api4/categories/list
```

### Response
#### Success Response (200)
- **categories** (array) - List of category objects.

#### Response Example
```json
{
  "categories": [
    {
      "id": "technology",
      "name": "Technology"
    },
    {
      "id": "finance",
      "name": "Finance"
    }
  ]
}
```
```

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

### Get Top Creators in Stocks

Source: https://lunarcrush.com/developers/api/overview

Fetches a list of top creators in the stocks domain.

```APIDOC
## GET /public/coins/list/v1

### Description
Retrieves a list of top creators in the stocks domain. (Note: The provided example endpoint seems to be a placeholder and might not be the actual endpoint for this specific query).

### Method
GET

### Endpoint
https://lunarcrush.com/api4/public/coins/list/v1 

### Parameters

#### Query Parameters
None

#### Request Body
None

### Request Example
```
GET https://lunarcrush.com/api4/public/coins/list/v1
```

### Response
#### Success Response (200)
- **creators** (array) - List of top creators in stocks.

#### Response Example
```json
{
  "creators": [
    {
      "id": "user123",
      "name": "StockGuru",
      "platform": "X"
    }
  ]
}
```
```

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

### Get Creator Posts

Source: https://lunarcrush.com/developers/api/overview

Fetches posts made by a specific creator.

```APIDOC
## GET /creators/{creator_id}/posts

### Description
Retrieves a list of posts made by a specific creator, identified by their ID.

### Method
GET

### Endpoint
https://lunarcrush.com/api4/creators/{creator_id}/posts

### Parameters
#### Path Parameters
- **creator_id** (string) - Required - The unique identifier of the creator.

#### Query Parameters
None

#### Request Body
None

### Request Example
```
GET https://lunarcrush.com/api4/creators/user123/posts
```

### Response
#### Success Response (200)
- **posts** (array) - List of post objects from the specified creator.

#### Response Example
```json
{
  "posts": [
    {
      "id": "post1",
      "content": "Exciting news about the latest tech!",
      "timestamp": "2023-10-27T10:00:00Z"
    }
  ]
}
```
```

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

### Fetch Public Topic Posts (Vanilla Node.js)

Source: https://lunarcrush.com/developers/api/public/topic/%3Atopic/posts/v1

A basic implementation using Node.js's built-in 'https' module to fetch data from the LunarCrush API. This example shows how to make a GET request with custom headers.

```JavaScript
const https = require('https');

function getTopicPostsNode(topic, token) {
  const url = `https://lunarcrush.com/api4/public/topic/${topic}/posts/v1`;
  const parsedUrl = new URL(url);

  const options = {
    hostname: parsedUrl.hostname,
    port: 443,
    path: parsedUrl.pathname,
    method: 'GET',
    headers: {
      'Authorization': token
    }
  };

  return new Promise((resolve, reject) => {
    const req = https.request(options, (res) => {
      let data = '';

      res.on('data', (chunk) => {
        data += chunk;
      });

      res.on('end', () => {
        try {
          resolve(JSON.parse(data));
        } catch (e) {
          reject('Error parsing JSON');
        }
      });
    });

    req.on('error', (error) => {
      reject(error);
    });

    req.end();
  });
}

// Example usage:
// const topic = "bitcoin";
// const authToken = "Bearer undefined"; // Replace with your actual token
// getTopicPostsNode(topic, authToken)
//   .then(data => {
//     console.log('Data:', data);
//     // Process data and extract insights here
//   })
//   .catch(error => {
//     console.error('Error fetching topic posts:', error);
//   });
```

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

### Get Top Mentioned Cryptocurrencies

Source: https://lunarcrush.com/developers/api/overview

Fetches a list of the top mentioned cryptocurrencies.

```APIDOC
## GET /public/coins/list/v1

### Description
Retrieves a list of the top mentioned cryptocurrencies.

### Method
GET

### Endpoint
https://lunarcrush.com/api4/public/coins/list/v1

### Parameters

#### Query Parameters
None

#### Request Body
None

### Request Example
```
GET https://lunarcrush.com/api4/public/coins/list/v1
```

### Response
#### Success Response (200)
- **coins** (array) - List of top mentioned cryptocurrencies.

#### Response Example
```json
{
  "coins": [
    {
      "id": "bitcoin",
      "name": "Bitcoin",
      "symbol": "BTC",
      "rank": 1
    },
    {
      "id": "ethereum",
      "name": "Ethereum",
      "symbol": "ETH",
      "rank": 2
    }
  ]
}
```
```

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

### GET /public/coins/:coin/meta/v1

Source: https://lunarcrush.com/developers/api/public/coins/%3Acoin/meta/v1

Retrieves meta information for a specific cryptocurrency project, including website and social media links.

```APIDOC
## GET /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.

### Method
GET

### Endpoint
`https://lunarcrush.com/api4/public/coins/:coin/meta/v1`

### Parameters
#### Path Parameters
- **coin** (string) - Required - The numeric ID or symbol of the coin or token.

### Request Example
```json
{
  "message": "This endpoint does not require a request body."
}
```

### Response
#### Success Response (200)
- **meta_data** (object) - Contains various meta information about the coin.

#### Response Example
```json
{
  "data": {
    "coin_id": 2,
    "symbol": "BTC",
    "name": "Bitcoin",
    "website": "https://bitcoin.org/",
    "social_links": [
      {"platform": "twitter", "link": "https://twitter.com/"}
    ]
  }
}
```

### Rate Limits
Guests are limited to 4 requests per minute and 100 requests per day. Discover subscribers are limited to 10 requests per minute and 2,000 requests per day maximum. Contact us using the chat icon on the bottom right of this screen to upgrade to higher rate limits.
```

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

### Get Top Cryptocurrency News Today

Source: https://lunarcrush.com/developers/api/overview

Fetches the top cryptocurrency news for the current day.

```APIDOC
## GET /public/coins/list/v1

### Description
Retrieves the top cryptocurrency news for today. (Note: The provided example endpoint seems to be a placeholder and might not be the actual endpoint for this specific query).

### Method
GET

### Endpoint
https://lunarcrush.com/api4/public/coins/list/v1

### Parameters

#### Query Parameters
None

#### Request Body
None

### Request Example
```
GET https://lunarcrush.com/api4/public/coins/list/v1
```

### Response
#### Success Response (200)
- **news** (array) - List of top cryptocurrency news articles.

#### Response Example
```json
{
  "news": [
    {
      "title": "Bitcoin Price Surges to New Highs",
      "source": "CryptoNews",
      "url": "https://example.com/news/bitcoin-surge"
    }
  ]
}
```
```

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

### Get Stock Snapshot Metrics

Source: https://lunarcrush.com/developers/api/overview

Fetches a general snapshot of LunarCrush metrics for all tracked stocks. Useful for monitoring assets individually or comparatively.

```APIDOC
## GET /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.

### Method
GET

### Endpoint
/public/stocks/list/v2

### Parameters

#### Query Parameters
* **metrics** (array) - Optional - A list of specific metrics to retrieve. If not provided, a default set of metrics will be returned.
  - Example: `["galaxy_score", "alt_rank", "market_cap"]`

### Response
#### Success Response (200)
- **stocks_metrics** (array) - An array of stock metric snapshots.
  - **symbol** (string) - The stock symbol.
  - **galaxy_score** (number) - The Galaxy Score™.
  - **alt_rank** (number) - The AltRank™.
  - **floor_price** (number) - The floor price.
  - **percent_change_24h** (number) - The 24-hour percent change.
  - **market_cap** (number) - The market capitalization.
  - **social_mentions** (number) - The number of social mentions.
  - **social_interactions** (number) - The number of social interactions.
  - **social_contributors** (number) - The number of social contributors.
  - **social_dominance** (number) - The social dominance percentage.
  - **categories** (array) - A list of categories the stock belongs to.

#### Response Example
```json
{
  "stocks_metrics": [
    {
      "symbol": "AAPL",
      "galaxy_score": 95.2,
      "alt_rank": 1,
      "floor_price": 170.5,
      "percent_change_24h": 1.5,
      "market_cap": 2.8e12,
      "social_mentions": 50000,
      "social_interactions": 1000000,
      "social_contributors": 15000,
      "social_dominance": 5.2,
      "categories": ["Technology", "Consumer Electronics"]
    }
  ]
}
```
```

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

### Get Coin Market Data

Source: https://lunarcrush.com/developers/api/public/coins/%3Acoin/v1

Retrieves market data for a specified coin or token using its numeric ID or symbol.

```APIDOC
## GET /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.

### Method
GET

### Endpoint
`https://lunarcrush.com/api4/public/coins/:coin/v1`

### Parameters
#### Path Parameters
- **coin** (string) - Required - The numeric ID or symbol of the coin or token.

### Request Example
```bash
curl -X GET \
  'https://lunarcrush.com/api4/public/coins/2/v1' \
  -H 'Authorization: Bearer YOUR_API_KEY'
```

### Response
#### Success Response (200)
- **data** (object) - Contains market data for the specified coin.
- **status** (string) - Indicates the status of the request.

#### Response Example
```json
{
  "data": {},
  "status": "success"
}
```

### Rate Limiting
Guests are limited to 4 requests per minute and 100 requests per day. Discover subscribers are limited to 10 requests per minute and 2,000 requests per day maximum. Contact support to upgrade rate limits.
```

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

### Get Market Data

Source: https://lunarcrush.com/developers/api/public/stocks/list/v1

Retrieves market data for cryptocurrencies and stocks, including price, volume, market cap, and social metrics. Supports pagination, sorting, and filtering.

```APIDOC
## GET /websites/lunarcrush_developers_api

### Description
Retrieves market data for cryptocurrencies and stocks. The response includes a configuration object with request parameters and details about the data generation, as well as an array of data objects, each representing an asset with its key metrics.

### Method
GET

### Endpoint
/websites/lunarcrush_developers_api

### Query Parameters
- **limit** (integer) - Optional - The number of results to return per page. Defaults to 10.
- **sort** (string) - Optional - The field by which to sort the results. Defaults to 'market_cap_rank'.
- **desc** (boolean) - Optional - Whether to sort in descending order. Defaults to true.
- **page** (integer) - Optional - The page number of the results to retrieve. Defaults to 0.

### Request Example
```json
{
  "example": "GET /websites/lunarcrush_developers_api?limit=10&sort=market_cap_rank&desc=true&page=0"
}
```

### Response
#### Success Response (200)
- **config** (object) - Configuration details for the request.
  - **limit** (integer) - The number of results returned per page.
  - **sort** (string) - The field used for sorting.
  - **desc** (boolean) - Indicates if sorting is in descending order.
  - **page** (integer) - The current page number.
  - **total_rows** (integer) - The total number of available rows.
  - **generated** (integer) - Unix timestamp indicating when the data was generated.
  - **notice** (string) - Information about the data mode (e.g., DEMO DATA MODE).
- **data** (array) - An array of asset data objects.
  - **id** (integer) - LunarCrush internal ID for the asset.
  - **symbol** (string) - The symbol for the asset.
  - **name** (string) - The full name of the asset.
  - **price** (number) - Current price in USD.
  - **volume_24h** (number) - Volume in USD for the last 24 hours.
  - **percent_change_24h** (number) - Percent change in price since 24 hours ago.
  - **market_cap** (number) - Total dollar market value.
  - **market_cap_rank** (integer) - The rank of the asset by market cap.
  - **interactions_24h** (number) - Number of interactions in the last 24 hours.
  - **social_volume_24h** (number) - Total number of posts with interactions in the last 24 hours.
  - **social_dominance** (number) - The percent of the total social volume this topic represents.
  - **market_dominance** (number) - The percent of the total market cap this asset represents.
  - **market_dominance_prev** (number) - The market dominance from the previous period.
  - **galaxy_score** (number) - A proprietary score based on technical indicators and social metrics.
  - **galaxy_score_previous** (number) - The galaxy score from the previous 24 hours.
  - **alt_rank** (number) - A proprietary score based on asset performance relative to others.
  - **alt_rank_previous** (number) - The alt rank from the previous 24 hours.
  - **sentiment** (number) - Percentage of posts weighted by interactions that are positive.
  - **categories** (array of strings) - An array of categories the asset aggregates into.
  - **topic** (string) - LunarCrush social topic.

#### Response Example
```json
{
  "config": {
    "limit": 10,
    "sort": "market_cap_rank",
    "desc": true,
    "page": 0,
    "total_rows": 2426,
    "generated": 1766171642,
    "notice": "DEMO DATA MODE: You must have a LunarCrush subscription to unlock real data. Get started at https://lunarcrush.com/pricing"
  },
  "data": [
    {
      "id": 7056,
      "symbol": "NVDA",
      "name": "NVIDIA Corp.",
      "price": 180.225,
      "volume_24h": 59851529254,
      "percent_change_24h": 3.486,
      "market_cap": 4375386100000,
      "market_cap_rank": 1,
      "interactions_24h": null,
      "social_volume_24h": null,
      "social_dominance": null,
      "market_dominance": 5.083,
      "market_dominance_prev": 5.094,
      "galaxy_score": null,
      "galaxy_score_previous": null,
      "alt_rank": null,
      "alt_rank_previous": null,
      "sentiment": null,
      "categories": ["technology"],
      "topic": "nvda nvidia corp"
    },
    {
      "id": 4336,
      "symbol": "GOOGL",
      "name": "Alphabet Inc Class A",
      "price": 304.1,
      "volume_24h": 14245629964,
      "percent_change_24h": 0.5620577927660007,
      "market_cap": 3670178050000,
      "market_cap_rank": 2,
      "interactions_24h": null,
      "social_volume_24h": null,
      "social_dominance": null,
      "market_dominance": 4.264,
      "market_dominance_prev": 4.388,
      "galaxy_score": null,
      "galaxy_score_previous": null,
      "alt_rank": null,
      "alt_rank_previous": null,
      "sentiment": null,
      "categories": ["communication-services"],
      "topic": "googl alphabet inc class a"
    }
  ]
}
```
```

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

### GET /public/coins/list/v2

Source: https://lunarcrush.com/developers/api/public/coins/list/v2

Retrieves a snapshot of LunarCrush metrics for all tracked coins. This endpoint is useful for monitoring available assets, their performance, and social engagement.

```APIDOC
## GET /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.

### Method
GET

### Endpoint
https://lunarcrush.com/api4/public/coins/list/v2

### Parameters
#### Query Parameters
- **sort** (string) - Optional - Allows sorting the output by a specific metric. Example: `market_cap_rank`
- **filter** (string) - Optional - Filters results by sub-categories or sectors. Separate multiple values with commas. Available sectors can be found at https://lunarcrush.com/categories/cryptocurrencies. Example: `meme`
- **limit** (integer) - Optional - Limits the number of results per page. Default is 10, maximum is 1000.
- **desc** (string) - Optional - Reverses the sort order (descending) if any value is provided.
- **page** (integer) - Optional - Specifies the page of results to display when using the `limit` parameter. Pages start at 0.

### Request Example
```
GET https://lunarcrush.com/api4/public/coins/list/v2?limit=10&page=0&sort=market_cap_rank&filter=meme
```

### Response
#### Success Response (200)
- **`data`** (array) - An array of coin objects, each containing various metrics.
  - **`id`** (string) - Unique identifier for the coin.
  - **`symbol`** (string) - Ticker symbol of the coin.
  - **`name`** (string) - Name of the coin.
  - **`market_cap`** (number) - The market capitalization of the coin.
  - **`price`** (number) - The current price of the coin.
  - **`alt_rank`** (number) - LunarCrush's AltRank score.
  - **`galaxy_score`** (number) - LunarCrush's Galaxy Score.
  - **`social_volume`** (number) - Social media mentions.
  - **`categories`** (array) - List of categories the coin belongs to.
  - ... (other metrics)

#### Response Example
```json
{
  "data": [
    {
      "id": "bitcoin",
      "symbol": "BTC",
      "name": "Bitcoin",
      "market_cap": 1200000000000,
      "price": 60000,
      "alt_rank": 1,
      "galaxy_score": 95,
      "social_volume": 50000,
      "categories": ["cryptocurrency", "PoW"]
      // ... other metrics
    }
    // ... more coin objects
  ],
  "next_page": "/api4/public/coins/list/v2?limit=10&page=1&sort=market_cap_rank&filter=meme"
}
```

### Rate Limiting
- Guests: 4 requests per minute, 100 requests per day.
- Discover subscribers: 10 requests per minute, 2,000 requests per day maximum.

### Changes
- 2024-01-03: v2 includes market and social data with options to sort and limit by metrics.
- 2024-01-26: Logos now available for each entry.
- 2024-03-18: Blockchain and contract address info for assets to help clearly identify the asset on chain.
- 2024-04-14: Includes the topic to use when looking up social data for this NFT collection as a social topic.
- 2024-09-13: Includes sentiment data.
- 2024-12-01: Added filter option to filter the results by specific sub categories/sectors. Try "meme" for example.
- 2025-04-28: Increased pagination limit to 1000.
```

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

### GET /public/topic/:topic/v1

Source: https://lunarcrush.com/developers/api/public/topic/%3Atopic/v1

Retrieves summary information for a given social topic. This endpoint provides a 24-hour aggregation of social activity, comparing the latest 24 hours to the previous 24 hours.

```APIDOC
## GET /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.

### Method
GET

### Endpoint
/public/topic/:topic/v1

### Parameters
#### Path Parameters
- **topic** (string) - Required - 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.

### Request Example
```json
{
  "topic": "bitcoin"
}
```

### Response
#### Success Response (200)
- **metrics** (object) - Social activity metrics for the topic.
- **comparison** (object) - Comparison of current 24-hour metrics to the previous 24 hours.

#### Response Example
```json
{
  "topic": "bitcoin",
  "total_posts": 15000,
  "total_comments": 5000,
  "total_likes": 25000,
  "sentiment": {
    "positive": 0.6,
    "negative": 0.2,
    "neutral": 0.2
  },
  "comparison": {
    "posts_change": "+10%",
    "comments_change": "-5%",
    "likes_change": "+15%"
  }
}
```
```

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

### GET /creator/:network/:screenName

Source: https://lunarcrush.com/developers/api/public/ai/creator/%3Anetwork/%3AscreenName

Fetches details of a social media creator based on the provided network and screen name. This endpoint is part of the LunarCrush AI LLM optimized website.

```APIDOC
## GET /creator/:network/:screenName

### Description
Fetches real-time social data for a specific creator from the LunarCrush AI platform. The URL structure is designed for AI agents to easily access this information.

### Method
GET

### Endpoint
`/creator/:network/:screenName`

### Parameters
#### Path Parameters
- **network** (string) - Required - The social network of the creator (e.g., "x", "youtube").
- **screenName** (string) - Required - The screen name or unique identifier of the creator (e.g., "elonmusk", "mrbeast").

### Request Example
```
https://lunarcrush.ai/creator/x/elonmusk
```

### Response
#### Success Response (200)
- **data** (object) - Contains detailed information about the creator. The exact structure may vary, but it includes social media statistics and insights.

#### Response Example
```json
{
  "data": { ... }
}
```
```

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

### List All Coins

Source: https://lunarcrush.com/developers/api/overview

Fetches a list of all available coins.

```APIDOC
## GET /coins/list

### Description
Retrieves a comprehensive list of all available cryptocurrencies tracked by LunarCrush.

### Method
GET

### Endpoint
https://lunarcrush.com/api4/coins/list

### Parameters

#### Query Parameters
None

#### Request Body
None

### Request Example
```
GET https://lunarcrush.com/api4/coins/list
```

### Response
#### Success Response (200)
- **coins** (array) - List of coin objects.

#### Response Example
```json
{
  "coins": [
    {
      "id": "bitcoin",
      "name": "Bitcoin",
      "symbol": "BTC"
    },
    {
      "id": "ethereum",
      "name": "Ethereum",
      "symbol": "ETH"
    }
  ]
}
```
```

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

### Get Top Posts for a Category

Source: https://lunarcrush.com/developers/api/public/category/%3Acategory/posts/v1

Retrieves the top posts for a specified social topic category. Supports time range filtering using start and end timestamps.

```APIDOC
## GET /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.

### Method
GET

### Endpoint
`/public/category/:category/posts/v1`

### Parameters
#### Path Parameters
- **category** (string) - Required - Provide the category to get details for. A category must be all lower case and can only include letters, numbers, and spaces.

#### Query Parameters
- **start** (unix timestamp) - Optional - The start time 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.
- **end** (unix timestamp) - Optional - The end time to stop at. Will be rounded to the end of the day.

### Request Example
```json
{
  "example": "(No request body for GET request)"
}
```

### Response
#### Success Response (200)
- **(structure of response body)** - Description of response fields (e.g., `posts` array, each with `title`, `url`, `interactions`, etc.)

#### Response Example
```json
{
  "example": "{}" 
}
```
```

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

### List All Coins v2

Source: https://lunarcrush.com/developers/api/overview

Fetches an updated list of all available coins.

```APIDOC
## GET /coins/list/v2

### Description
Retrieves an updated and potentially more detailed list of all available cryptocurrencies tracked by LunarCrush.

### Method
GET

### Endpoint
https://lunarcrush.com/api4/coins/list/v2

### Parameters

#### Query Parameters
None

#### Request Body
None

### Request Example
```
GET https://lunarcrush.com/api4/coins/list/v2
```

### Response
#### Success Response (200)
- **coins** (array) - List of detailed coin objects.

#### Response Example
```json
{
  "coins": [
    {
      "id": "bitcoin",
      "name": "Bitcoin",
      "symbol": "BTC",
      "market_cap": 1000000000000
    }
  ]
}
```
```

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

### List All Stocks v2

Source: https://lunarcrush.com/developers/api/overview

Fetches an updated list of all tracked stocks.

```APIDOC
## GET /stocks/list/v2

### Description
Retrieves an updated list of all stocks tracked by LunarCrush, potentially with more details.

### Method
GET

### Endpoint
https://lunarcrush.com/api4/stocks/list/v2

### Parameters

#### Query Parameters
None

#### Request Body
None

### Request Example
```
GET https://lunarcrush.com/api4/stocks/list/v2
```

### Response
#### Success Response (200)
- **stocks** (array) - List of detailed stock objects.

#### Response Example
```json
{
  "stocks": [
    {
      "symbol": "AAPL",
      "name": "Apple Inc.",
      "exchange": "NASDAQ"
    }
  ]
}
```
```

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

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

Source: https://lunarcrush.com/developers/api/public/creator/%3Anetwork/%3Aid/time-series/v1

Retrieves time series data for a specific creator on a given social network. This endpoint allows fetching historical data in hourly or daily buckets, with options to specify time intervals or exact start and end times.

```APIDOC
## GET /public/creator/:network/:id/time-series/v1

### Description
Get time series data on a creator.

### Method
GET

### Endpoint
`https://lunarcrush.com/api4/public/creator/:network/:id/time-series/v1`

### Parameters
#### Path Parameters
- **network** (string) - Required - Influencer social network (e.g., "twitter").
- **id** (string) - Required - The unique id or screen name of the creator (e.g., "lunarcrush").

#### Query Parameters
- **bucket** (string) - Optional - Bucket time series data into hours or days. Defaults to hours.
- **interval** (string) - Optional - Use interval to specify the start and end time automatically for convenience. If "start" or "end" parameters are provided this parameter is ignored (e.g., "1w").
- **start** (timestamp) - Optional - The start time (unix timestamp) to go back to.
- **end** (timestamp) - Optional - The end time (unix timestamp) to stop at.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **data** (array) - Array of time series data points.
  - **timestamp** (integer) - The timestamp of the data point.
  - **metric_name** (string) - The name of the metric.
  - **metric_value** (number) - The value of the metric.

#### Response Example
```json
{
  "data": [
    {
      "timestamp": 1678886400,
      "metric_name": "followers",
      "metric_value": 150000
    },
    {
      "timestamp": 1678890000,
      "metric_name": "followers",
      "metric_value": 150500
    }
  ]
}
```

### Rate Limiting
Guests are limited to 4 requests per minute and 100 requests per day. Discover subscribers are limited to 10 requests per minute and 2,000 requests per day maximum. Contact support to upgrade rate limits.
```

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

### List All Stocks

Source: https://lunarcrush.com/developers/api/overview

Fetches a list of all tracked stocks.

```APIDOC
## GET /stocks/list

### Description
Retrieves a list of all stocks tracked by LunarCrush.

### Method
GET

### Endpoint
https://lunarcrush.com/api4/stocks/list

### Parameters

#### Query Parameters
None

#### Request Body
None

### Request Example
```
GET https://lunarcrush.com/api4/stocks/list
```

### Response
#### Success Response (200)
- **stocks** (array) - List of stock objects.

#### Response Example
```json
{
  "stocks": [
    {
      "symbol": "AAPL",
      "name": "Apple Inc."
    },
    {
      "symbol": "MSFT",
      "name": "Microsoft Corporation"
    }
  ]
}
```
```

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

### GET /public/topic/:topic/posts/v1

Source: https://lunarcrush.com/developers/api/public/topic/%3Atopic/posts/v1

Retrieves the top posts for a given social topic. If a start time is provided, it returns the top posts by interactions within the specified time range. Otherwise, it returns the most recent top posts from the last 24 hours.

```APIDOC
## GET /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.

### Method
GET

### Endpoint
`/public/topic/:topic/posts/v1`

### Parameters
#### Path Parameters
- **topic** (string) - Required - Provide the topic to get details for. A topic must be all lower case and can only include letters, numbers, spaces, # and $.

#### Query Parameters
- **start** (unix timestamp) - Optional - 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.
- **end** (unix timestamp) - Optional - The end time (unix timestamp) to stop at. Will be rounded to the end of the day.

### Request Example
```json
{
  "topic": "bitcoin",
  "start": 1678886400,
  "end": 1678972800
}
```

### Response
#### Success Response (200)
- **posts** (array) - An array of post objects.
  - **topic** (string) - The social topic of the post.
  - **creator_avatar_url** (string) - The avatar URL of the post creator.
  - **sentiment** (number) - The sentiment score of the post.
  - **post_link** (string) - A link to the original post.
  - **post_image** (string) - The primary image URL of the post, if available.

#### Response Example
```json
{
  "posts": [
    {
      "topic": "bitcoin",
      "creator_avatar_url": "https://example.com/avatar.jpg",
      "sentiment": 0.75,
      "post_link": "https://example.com/post/123",
      "post_image": "https://example.com/image.jpg"
    }
  ]
}
```
```

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

### AI Topic Whatsup Summary (v1)

Source: https://lunarcrush.com/developers/api/public/topic/%3Atopic/whatsup/v1

Generates an AI summary of the hottest news and social posts for a specific topic. This endpoint requires a Builder or higher subscription with upgraded API access.

```APIDOC
## GET /public/topic/:topic/whatsup/v1

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

### Method
GET

### Endpoint
`/public/topic/:topic/whatsup/v1`

### Parameters
#### Path Parameters
- **topic** (string) - Required - Provide the topic to get a summary for. A topic must be all lower case and can only include letters, numbers, spaces, # and $.

### Request Example
```json
{
  "example": "A request for the bitcoin topic"
}
```

### Response
#### Success Response (200)
- **summary** (string) - AI-generated summary of the hottest news and social posts for the topic.
- **supportive_themes** (array) - Array of supportive themes related to the topic summary.
- **critical_themes** (array) - Array of critical themes related to the topic summary.

#### Response Example
```json
{
  "summary": "Bitcoin continues to show strong market resilience, with recent news highlighting increased institutional adoption and positive regulatory developments. Social media sentiment remains largely optimistic, driven by ongoing technological advancements and its status as a digital store of value.",
  "supportive_themes": [
    "Institutional Adoption",
    "Regulatory Clarity",
    "Technological Advancements"
  ],
  "critical_themes": [
    "Market Volatility",
    "Competition from Altcoins"
  ]
}
```

### Rate Limiting
Guests are limited to 4 requests per minute and 100 requests per day. Discover subscribers are limited to 10 requests per minute and 2,000 requests per day maximum.

### Changes
- **2025-03-05**: Introduced new topic whatsup AI summary endpoint.
- **2025-11-13**: Topic whatsup summary endpoint now includes supportive and critical themes.
```

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

### Search Create

Source: https://lunarcrush.com/developers/api/overview

Creates a new search entry.

```APIDOC
## POST /searches/create

### Description
Allows users to create a new search record.

### Method
POST

### Endpoint
https://lunarcrush.com/api4/searches/create

### Parameters

#### Query Parameters
None

#### Request Body
- **query** (string) - Required - The search query string.

### Request Example
```json
{
  "query": "ethereum news"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the search was created.

#### Response Example
```json
{
  "message": "Search created successfully."
}
```
```

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

### GET /public/topics/list/v1

Source: https://lunarcrush.com/developers/api/public/topics/list/v1

Retrieves a list of trending social topics. This endpoint is rate-limited for guests and Discover subscribers.

```APIDOC
## GET /public/topics/list/v1

### Description
Get a list of trending social topics.

### Method
GET

### Endpoint
/public/topics/list/v1

### Parameters
#### Query Parameters
(No query parameters documented)

#### Request Body
(No request body documented)

### Request Example
(No specific request example provided, but includes example headers for Python)
```python
import requests

url = "https://lunarcrush.com/api4/public/topics/list/v1"
headers = {
    "Authorization": "Bearer undefined"
}

response = requests.get(url, headers=headers)
print(response.json())
```

### Response
#### Success Response (200)
(Response structure is an empty JSON object `{}` based on the provided example, but typically contains a list of topics.)

#### Response Example
```json
{
  "example": "{}"
}
```

### Rate Limits
Guests are limited to 4 requests per minute and 100 requests per day. Discover subscribers are limited to 10 requests per minute and 2,000 requests per day maximum.
```

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

### POST /public/searches/create

Source: https://lunarcrush.com/developers/api/public/searches/create

Creates a custom search aggregation of topics and search terms, allowing fine-tuning of included or excluded posts. Search terms and configuration cannot be altered after creation.

```APIDOC
## POST /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.

### Method
POST

### Endpoint
/public/searches/create

### Parameters
#### Request Body
- **name** (string) - Required - The name of the custom search aggregation.
- **search_json** (string) - Required - 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.
- **priority** (boolean) - Optional - Flag as a high priority search aggregation. Pro accounts get up to 10 high priority search aggregations at a time.

### Request Example
```json
{
  "name": "My Custom Search",
  "search_json": "{\"terms\":[{\"term\":\"bitcoin\", \"include\":[], \"exclude\":[]}]}",
  "priority": true
}
```

### Response
#### Success Response (200)
- **id** (string) - The ID of the newly created search aggregation.
- **slug** (string) - The slug for the new search aggregation.
- **processed_search_config** (object) - The processed search configuration.

#### Response Example
```json
{
  "id": "12345",
  "slug": "my-custom-search-12345",
  "processed_search_config": {
    "terms": [
      {
        "term": "bitcoin",
        "include": [],
        "exclude": []
      }
    ]
  }
}
```
```

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

### GET /public/posts/:post_type/:post_id/v1

Source: https://lunarcrush.com/developers/api/public/posts/%3Apost_type/%3Apost_id/v1

Retrieves detailed information about a specific post, including its type and unique identifier.

```APIDOC
## GET /public/posts/:post_type/:post_id/v1

### Description
Get details of a post by specifying its type and ID.

### Method
GET

### Endpoint
`https://lunarcrush.com/api4/public/posts/:post_type/:post_id/v1`

### Parameters
#### Path Parameters
- **post_type** (string) - Required - The type of the post (e.g., "tweet", "youtube-video", "tiktok-video", "reddit-post", "instagram-post").
- **post_id** (string) - Required - The unique identifier of the post.

### Request Example
```json
{
  "example": "GET https://lunarcrush.com/api4/public/posts/tweet/1756378079893782591/v1"
}
```

### Response
#### Success Response (200)
- **[response fields]** (object) - Details of the requested post. The exact fields depend on the post type.

#### Response Example
```json
{
  "example": "{}" 
}
```

### Rate Limiting
- Guests: 4 requests per minute, 100 requests per day.
- Discover subscribers: 10 requests per minute, 2,000 requests per day maximum.
```

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

### Topic Whatsup Summary API

Source: https://lunarcrush.com/developers/api/changes

Retrieve AI-generated summaries of the hottest news and social posts for a specific topic, including supportive and critical themes.

```APIDOC
## GET /topic/:topic/whatsup/v1

### Description
This endpoint provides an AI-generated summary of the latest news and social posts related to a specific topic. It also includes supportive and critical themes associated with the summary.

### Method
GET

### Endpoint
/topic/:topic/whatsup/v1

### Parameters
#### Path Parameters
- **topic** (string) - Required - The identifier for the topic.

### Request Example
```json
{
  "example": "GET /topic/bitcoin/whatsup/v1"
}
```

### Response
#### Success Response (200)
- **summary** (string) - The AI-generated summary of the topic.
- **supportive_themes** (array) - A list of themes supporting the summary.
- **critical_themes** (array) - A list of themes critical to the summary.

#### Response Example
```json
{
  "summary": "Bitcoin continues to show strong upward momentum driven by positive institutional adoption news and increasing retail interest. Key supportive themes include...', 
  "supportive_themes": ["Institutional Adoption", "Retail Interest", "Market Sentiment"],
  "critical_themes": ["Regulatory Uncertainty", "Market Volatility"]
}
```
```