> 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/coin-traders.md).

# Coin Traders

Retrieve trader statistics for a specific coin in a selected period.\
Each record represents one wallet address with buy/sell activity and estimated PnL.

## Endpoint

```http
GET /api/v1/partner/coin-traders
```

## Parameters

### Query Parameters

| Name               | Type   | Required | Description                                                                                                                     |
| ------------------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `coin_type`        | string | Yes      | Coin identifier (for example: `0x...::module::COIN`).                                                                           |
| `period`           | string | Yes      | Time range. One of: `30d`, `7d`, `3d`, `1d`.                                                                                    |
| `limit`            | number | No       | Number of records to return. Default: `20`.                                                                                     |
| `offset`           | number | No       | Number of records to skip. Default: `0`.                                                                                        |
| `sort_field`       | string | No       | Sort field. One of: `tx_buy`, `tx_sell`, `total_tx`, `amount_buy`, `amount_sell`, `vol_buy`, `vol_sell`, `pnl`. Default: `pnl`. |
| `sort_direction`   | string | No       | Sort direction: `asc` or `desc`. Default: `desc`.                                                                               |
| `protocol`         | string | No       | Comma-separated protocol keys (for example: `cetus-clmm,momentum-clmm`).                                                        |
| `wallet_addresses` | string | No       | Comma-separated wallet addresses to filter results.                                                                             |

## Headers

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

## cURL Example

```bash
curl --location 'https://api.noodles.fi/api/v1/partner/coin-traders?coin_type=0xd1b72982e40348d069bb1ff701e634c117bb5f741f44dff91e472d3b01461e55::stsui::STSUI&period=30d&limit=20&offset=0&sort_field=pnl&sort_direction=desc&protocol=cetus-clmm,momentum-clmm&wallet_addresses=0x5b712236facb45aeadb0f48fcb90f3e9b17a5b4740ab33c5f119e98209d94208,0x7e17ed25424ca1e811d2627583000734c57636362392d8ca6e43f7b203171bbd' \
--header 'Accept-Encoding: application/json' \
--header 'x-api-key: YOUR_API_KEY'
```

## Response

### Fields

| Field     | Type   | Nullable | Description                |
| --------- | ------ | -------- | -------------------------- |
| `code`    | number | No       | HTTP status code.          |
| `message` | string | No       | Response message.          |
| `data`    | array  | No       | List of trader statistics. |

### Trader Object

| Field         | Type   | Nullable | Description                       |
| ------------- | ------ | -------- | --------------------------------- |
| `address`     | string | No       | Trader wallet address.            |
| `tx_buy`      | number | No       | Number of buy transactions.       |
| `tx_sell`     | number | No       | Number of sell transactions.      |
| `amount_buy`  | number | No       | Total bought token amount.        |
| `amount_sell` | number | No       | Total sold token amount.          |
| `vol_buy`     | number | No       | Total buy volume in USD.          |
| `vol_sell`    | number | No       | Total sell volume in USD.         |
| `pnl`         | number | No       | Estimated profit and loss in USD. |

### Success Response

```json
{
  "code": 200,
  "message": "OK",
  "data": [
    {
      "address": "0x5b712236facb45aeadb0f48fcb90f3e9b17a5b4740ab33c5f119e98209d94208",
      "tx_buy": 29,
      "tx_sell": 99,
      "amount_buy": 4171.835527698,
      "amount_sell": 22136.173695786,
      "vol_buy": 4288,
      "vol_sell": 24756,
      "pnl": 20468
    },
    {
      "address": "0x7e17ed25424ca1e811d2627583000734c57636362392d8ca6e43f7b203171bbd",
      "tx_buy": 4,
      "tx_sell": 100,
      "amount_buy": 244.95742228,
      "amount_sell": 11476.128636042,
      "vol_buy": 274.91,
      "vol_sell": 12962,
      "pnl": 12687
    }
  ]
}
```

***

> **See also:** [Environment Setup](/docs.noodles.fi/environment-setup/environment.md)


---

# 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/coin-traders.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.
