> For the complete documentation index, see [llms.txt](https://noodles-finance.gitbook.io/docs.noodles.fi/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://noodles-finance.gitbook.io/docs.noodles.fi/coin/global-search.md).

# Global Search

Search coins, liquidity pools, wallets by keyword

***

## **Endpoint**

```
GET /api/v1/partner/global-search
```

## **Request Parameters**

| Name      | Type    | Required | Description                                                    |
| --------- | ------- | -------- | -------------------------------------------------------------- |
| `keyword` | string  | **Yes**  | Search keyword to match against coins, pools, wallets.         |
| `scope`   | string  | **Yes**  | Search scope. Must be one of: `all`, `coin`, `pool`, `wallet`. |
| `limit`   | integer | No       | Maximum number of results to return per category. Default: 10. |

### Scope Values

| Scope    | Description                                           |
| -------- | ----------------------------------------------------- |
| `all`    | Search across all categories (coins, pools, wallets). |
| `coin`   | Search only for coins.                                |
| `pool`   | Search only for liquidity pools.                      |
| `wallet` | Search only for wallet addresses.                     |

***

## **Headers**

| Header      | Required | Description                |
| ----------- | -------- | -------------------------- |
| `x-api-key` | Yes      | API key for authorization. |

***

## **cURL Example**

```bash
curl --location 'https://api.noodles.fi/api/v1/partner/global-search?keyword=SUI&scope=all&limit=5' \
--header 'Accept-Encoding: application/json' \
--header 'x-api-key: YOUR_API_KEY'
```

***

## **Response**

### Success Response Example

```json
{
    "code": 200,
    "message": "OK",
    "data": {
        "coin": [
            {
                "coin_type": "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI",
                "name": "Sui",
                "symbol": "SUI",
                "logo": "https://imagedelivery.net/cBNDGgkrsEA-b_ixIp9SkQ/sui-coin.svg/public",
                "verified": true,
                "volume_24h": 125000000.50,
                "volume_change_24h": 5.2,
                "price": 3.25,
                "price_change_1d": 2.5,
                "liquidity": 450000000.75,
                "market_cap": 850000000.00
            }
        ],
        "wallet": [
            {
                "address": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
                "verified": true
            }
        ],
        "liquidity_pool": [
            {
                "pool_address": "0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
                "coin_a_id": "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI",
                "coin_a_symbol": "SUI",
                "coin_a_logo": "https://imagedelivery.net/cBNDGgkrsEA-b_ixIp9SkQ/sui-coin.svg/public",
                "coin_a_verified": true,
                "coin_b_id": "0x5d4b302506645c37ff133b98c4b50a5ae14841659738d6d733d59d0d217a93bf::coin::COIN",
                "coin_b_symbol": "USDC",
                "coin_b_logo": "https://imagedelivery.net/cBNDGgkrsEA-b_ixIp9SkQ/usdc-coin.svg/public",
                "coin_b_verified": true,
                "protocol": "cetus-clmm",
                "pool_type": "clmm",
                "tvl_usd": 25000000.50,
                "amount_a": 5000000.123456789,
                "amount_b": 16250000.000000,
                "liquidity_a_usd": 16250000.40,
                "liquidity_b_usd": 16250000.00,
                "volume_24h": 8500000.75,
                "volume_24h_change": 12.5,
                "apr_24h": 25.8,
                "fee_rate": 0.3,
                "fee_generated": 25500.00,
                "is_yield": false
            }
        ],

    }
}
```

### Response Fields

| Field     | Type   | Nullable | Description                |
| --------- | ------ | -------- | -------------------------- |
| `code`    | number | No       | HTTP status code.          |
| `message` | string | No       | Response message.          |
| `data`    | object | No       | Global search data object. |

### Data Object Fields

| Field            | Type  | Nullable | Description                             |
| ---------------- | ----- | -------- | --------------------------------------- |
| `coin`           | array | No       | Array of coin search results.           |
| `wallet`         | array | No       | Array of wallet search results.         |
| `liquidity_pool` | array | No       | Array of liquidity pool search results. |

### Coin Search Object

| Field               | Type    | Nullable | Description                        |
| ------------------- | ------- | -------- | ---------------------------------- |
| `coin_type`         | string  | No       | The unique identifier of the coin. |
| `name`              | string  | No       | Full name of the coin.             |
| `symbol`            | string  | No       | The coin's symbol/ticker.          |
| `logo`              | string  | No       | URL to the coin's logo image.      |
| `verified`          | boolean | No       | Whether the coin is verified.      |
| `volume_24h`        | number  | Yes      | 24-hour trading volume in USD.     |
| `volume_change_24h` | number  | Yes      | 24-hour volume change percentage.  |
| `price`             | number  | Yes      | Current price in USD.              |
| `price_change_1d`   | number  | Yes      | 24-hour price change percentage.   |
| `liquidity`         | number  | Yes      | Total liquidity in USD.            |
| `market_cap`        | number  | Yes      | Market capitalization in USD.      |

### Wallet Search Object

| Field      | Type    | Description                     |
| ---------- | ------- | ------------------------------- |
| `address`  | string  | Wallet address.                 |
| `verified` | boolean | Whether the wallet is verified. |

### Liquidity Pool Search Object

| Field               | Type    | Description                                           |
| ------------------- | ------- | ----------------------------------------------------- |
| `pool_address`      | string  | Pool address/identifier.                              |
| `coin_a_id`         | string  | Coin type identifier for coin A.                      |
| `coin_a_symbol`     | string  | Symbol for coin A.                                    |
| `coin_a_logo`       | string  | Logo URL for coin A.                                  |
| `coin_a_verified`   | boolean | Whether coin A is verified.                           |
| `coin_b_id`         | string  | Coin type identifier for coin B.                      |
| `coin_b_symbol`     | string  | Symbol for coin B.                                    |
| `coin_b_logo`       | string  | Logo URL for coin B.                                  |
| `coin_b_verified`   | boolean | Whether coin B is verified.                           |
| `protocol`          | string  | Protocol name (e.g., "cetus-clmm", "aftermath-cpmm"). |
| `pool_type`         | string  | Type of pool (e.g., "clmm", "cpmm").                  |
| `tvl_usd`           | number  | Total Value Locked in USD.                            |
| `amount_a`          | number  | Amount of coin A in the pool.                         |
| `amount_b`          | number  | Amount of coin B in the pool.                         |
| `liquidity_a_usd`   | number  | USD value of coin A liquidity.                        |
| `liquidity_b_usd`   | number  | USD value of coin B liquidity.                        |
| `volume_24h`        | number  | 24-hour trading volume in USD.                        |
| `volume_24h_change` | number  | 24-hour volume change percentage.                     |
| `apr_24h`           | number  | 24-hour Annual Percentage Rate.                       |
| `fee_rate`          | number  | Fee rate for the pool (in percentage).                |
| `fee_generated`     | number  | Total fees generated.                                 |
| `is_yield`          | boolean | Whether the pool generates yield.                     |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://noodles-finance.gitbook.io/docs.noodles.fi/coin/global-search.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.