# Get Token by Address

```bash
GET https://www.clanker.world/api/get-clanker-by-address
```

**Headers:**

```
x-api-key: your_api_key
```

**Query Parameters:**

| Parameter | Type   | Description                                    |
| --------- | ------ | ---------------------------------------------- |
| `address` | string | Ethereum address of the Clanker token contract |

**Example Request:**

```bash
curl -X GET \
  'https://www.clanker.world/api/get-clanker-by-address?address=0x1bc0c42215582d5A085795f4baDbaC3ff36d1Bcb' \
  -H 'x-api-key: your_api_key'
```

### Response Format

**Example Response:**

```json
{
  "data":
  {
    "id": 241400,
    "created_at": "2025-04-15T00:16:39.464442+00:00",
    "tx_hash": "0x581b54f7b59def7483eb0306d924f82910582d3d024f2dd9a2195341eacd43b9",
    "contract_address": "0x6270BCB5398927335AEf599EdD1CC666FcC77797",
    "name": "deployer",
    "symbol": "$deployer",
    "pool_address": "0x213264B1Bc0F39f705687fdaBe97E8b3F8B3455F",
    "cast_hash": "bankr deployment",
    "type": "clanker_v3_1",
    "pair": "WETH",
    "chain_id": 8453,
    "metadata": {
      "auditUrls": [],
      "description": "",
      "socialMediaUrls": []
    },
    "deploy_config": {
      "devBuyAmount": 0,
      "lockupPercentage": 0,
      "vestingUnlockDate": 0
    },
    "social_context": {
      "interface": "Bankr",
      "messageId": "bankr deployment",
      "id": "886870"
      "platform": "Farcaster"
    },
    "requestor_fid": 886870,
    "deployed_at": "2025-04-15T00:16:35",
    "msg_sender": "0x2112b8456AC07c15fA31ddf3Bf713E77716fF3F9",
    "factory_address": "0x2A787b2362021cC3eEa3C24C4748a6cD5B687382",
    "locker_address": "0x33e2Eda238edcF470309b8c6D228986A1204c8f9",
    "warnings": [],
    "pool_config": {
      "pairedToken": "0x4200000000000000000000000000000000000006",
      "tickIfToken0IsNewToken": -230400
    },
    "starting_market_cap": 9.870869513221747
  },
}
```

#### Response Fields

| Field  | Type   | Description                                        |
| ------ | ------ | -------------------------------------------------- |
| `data` | object | Container object for the Clanker token information |

#### Token Object Fields

| Field                 | Type            | Description                                                                  |
| --------------------- | --------------- | ---------------------------------------------------------------------------- |
| id                    | number          | Unique identifier for the token                                              |
| created\_at           | string          | ISO 8601 timestamp of token creation                                         |
| tx\_hash              | string          | Transaction hash of the deployment                                           |
| contract\_address     | string          | Token contract address                                                       |
| requestor\_fid        | integer         | Farcaster ID of the token requestor                                          |
| name                  | string          | Token name                                                                   |
| symbol                | string          | Token symbol                                                                 |
| img\_url              | string          | URL of the token's image                                                     |
| pool\_address         | string          | Address of the token's liquidity pool                                        |
| cast\_hash            | string          | Associated Farcaster cast hash                                               |
| type                  | string \| null  | Token type identifier                                                        |
| pair                  | string \| null  | Trading pair identifier                                                      |
| presale\_id           | integer \| null | ID of associated presale if applicable                                       |
| chain\_id             | integer         | Blockchain chain ID                                                          |
| metadata              | string          | Additional token metadata                                                    |
| deploy\_config        | object          | Deployment configuration details: creator buy, creator vault, etc.           |
| social\_context       | object          | Social context of the token creation                                         |
| deployed\_at          | string          | Timestamp of token deployment                                                |
| msg\_sender           | string          | Address that sent the deployment transaction                                 |
| factory\_address      | string          | Address of the Clanker token factory conract                                 |
| locker\_address       | string          | Address of the Clanker token locker contract                                 |
| warnings              | array           | Array of warning flags. See "Warning Flags" section below                    |
| starting\_market\_cap | number          | Starting market cap of the pool denominated in the quote token               |
| pool\_config          | object          | Pool configuration details: quote token address and initial tick of the pool |

{% hint style="danger" %}

### Warning Flags

* `UNUSUAL_TICK`
  * WETH-denominated tokens with a starting market cap of < 1 ETH (WETH)
  * Non-WETH tokens listed in [Supported Quote Tokens](/documentation/references/supported-quote-tokens.md) with pools that do not match the initial tick listed in that table
* `UNUSUAL_PAIR_ADDRESS`
  * Tokens paired with a quote token not listed in [Supported Quote Tokens](/documentation/references/supported-quote-tokens.md)
* `MISSING_POOL_CONFIG`
  * Tokens with incomplete or missing pool configuration info. These are primary legacy tokens that were deployed with a standard configuration
    {% endhint %}

{% hint style="info" %}

#### Notes

* The `created_at` timestamp is returned in UTC timezone
* The `img_url` field provides a direct link to the token's image asset
* The `requestor_fid` can be used to link to the token creator's Farcaster profile
  {% endhint %}


---

# Agent Instructions: 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:

```
GET https://clanker.gitbook.io/documentation/authenticated/get-token-by-address.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
