Honeypot API

https://docs.honeypot.is/
Admin
The Honeypot API allows developers to integrate honeypot checks into their products, providing...
Tokens:15,996
Snippets:69
Trust Score:8.5
Update:11 months ago
Show doc for...
Tokens:
Raw
### Check cURL Version

Source: https://docs.honeypot.is/quickstart

This snippet demonstrates how to check the installed version of cURL, a common command-line tool for making HTTP requests. It requires cURL to be installed on the user's machine.

```shell
# cURL is most likely already installed on your machine
curl --version

```

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

### IsHoneypot Endpoint

Source: https://docs.honeypot.is/quickstart

Check if a given token is a honeypot by sending a GET request to the /v2/IsHoneypot endpoint.

```APIDOC
## GET /v2/IsHoneypot

### Description
Checks if a given token is a honeypot.

### Method
GET

### Endpoint
`/v2/IsHoneypot`

### Parameters
#### Query Parameters
- **address** (string) - Required - The token address to check.
- **X-API-KEY** (string) - Optional - Your API key for authentication. Note: API Keys are currently not required.

### Request Example
```bash
curl -G https://api.honeypot.is/v2/IsHoneypot \
  -H "X-API-KEY: {APIKEY}" \
  -d address=0x0
```

### Response
#### Success Response (200)
- **isHoneypot** (boolean) - True if the address is a honeypot, false otherwise.

#### Response Example
```json
{
  "isHoneypot": true
}
```
```

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

### Make GET Request to IsHoneypot Endpoint

Source: https://docs.honeypot.is/quickstart

This snippet shows how to make a GET request to the `/v2/IsHoneypot` endpoint using cURL to check if a given address is a honeypot. It includes an API key header and a query parameter for the address. Replace `{APIKEY}` with your actual API key.

```curl
curl -G https://api.honeypot.is/v2/IsHoneypot \
  -H "X-API-KEY: {APIKEY}" \
  -d address=0x0

```

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

### Honeypot API Error Response Example (JSON)

Source: https://docs.honeypot.is/errors

This JSON object represents a typical error response from the Honeypot API. It includes an error code and a descriptive error message to help with debugging client-side issues.

```json
{
  "code": 400,
  "error": "invalid token address"
}
```

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

### Get Pairs Request Example (cURL)

Source: https://docs.honeypot.is/pairs

This snippet demonstrates how to make a GET request to the /v1/GetPairs endpoint using cURL. It includes the API key, token address, and optional chain ID as parameters. The response is a JSON array of token pairs.

```shell
curl -G https://api.honeypot.is/v1/GetPairs \
-H "X-API-KEY: {APIKEY}" \
-d address=0x6982508145454Ce325dDbE47a25d4ec3d2311933 \
-d chainID=1
```

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

### API Response Summary Example

Source: https://docs.honeypot.is/ishoneypot

This JSON snippet shows an example of the 'summary' object in an API response. It includes the overall risk level, a detailed risk score, and a list of flags with their severity and descriptions. The 'risk' field indicates the general risk, while 'riskLevel' provides a numerical score. 'flags' detail specific issues found with the token.

```json
{
  "summary": {
    "risk": "honeypot",
    "riskLevel": 100,
    "flags": [
      {
        "flag": "high_fail_rate",
        "description": "Transfers between normal wallets are blockedA very high amount of users can not sell their tokens.",
        "severity": "critical",
        "severityIndex": 20
      },
      {
        "flag": "CLOSED_SOURCE",
        "description": "The source code is not available, allowing for hidden functionality.",
        "severity": "high",
        "severityIndex": 16
      }
    ]
  }
}
```

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

### Get Top Holders Request (curl)

Source: https://docs.honeypot.is/topholders

Example of how to make a GET request to the TopHolders endpoint using curl. It requires the token address and chain ID as parameters, along with an API key for authentication.

```curl
curl -G https://api.honeypot.is/v1/TopHolders \
-H "X-API-KEY: {APIKEY}" \
-d address=0xe786c0da51a21c8f7ec91c9889e2df3f21ee1747 \
-d chainID=1
```

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

### Authenticate Honeypot API using cURL with Header Authorization

Source: https://docs.honeypot.is/authentication

This snippet demonstrates how to authenticate with the Honeypot API using cURL by passing the API key in the 'X-API-KEY' header. This is the recommended method for secure API access. Ensure you replace '{APIKEY}' with your actual API key.

```bash
curl https://api.honeypot.is/v2/IsHoneypot \
  -H "X-API-KEY: {APIKEY}"
```

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

### Get Pairs Response Example (JSON)

Source: https://docs.honeypot.is/pairs

This snippet shows a sample JSON response from the /v1/GetPairs endpoint. Each object in the array represents a token pair, including its ChainID, Pair details (Name, Tokens, Address), Reserves, Liquidity, and Router address. The endpoint currently limits results to 10 pairs.

```json
[
{
    "ChainID": 1,
    "Pair": {
        "Name": "Uniswap V2: PEPE-WETH",
        "Tokens": [
            "0x6982508145454ce325ddbe47a25d4ec3d2311933",
            "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2"
        ],
        "Address": "0xa43fe16908251ee70ef74718545e4fe6c5ccec9f"
    },
    "Reserves": [
        2309863147202366390632917740976,
        3657182645473588411835
    ],
    "Liquidity": 13795258.656990923,
    "Router": "0x7a250d5630b4cf539739df2c5dacb4c659f2488d"
}
// The remaining 9 pairs...
]
```

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

### Example Honeypot Flag Structure in API Response

Source: https://docs.honeypot.is/summary_flags

Illustrates the JSON structure of a single flag as returned by the IsHoneypot API. It includes the flag name, its English description, and its severity level with a corresponding index.

```json
{
  "flag": "TRANSFER_BLOCKED",
  "description": "Normal transfers between wallets are blocked, those are non-DEX transactions.",
  "severity": "medium",
  "severityIndex": 12
}
```

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

### API Error Response Structure

Source: https://docs.honeypot.is/errors

This section illustrates the typical structure of an error response from the Honeypot API, including the error code and a descriptive message.

```APIDOC
## Error Response Example

### Description
This example shows the JSON structure returned for an unsuccessful API request, indicating the error code and a specific error message.

### Response Example
```json
{
  "code": 400,
  "error": "invalid token address"
}
```
```

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

### Get Top Holders Response (JSON)

Source: https://docs.honeypot.is/topholders

Example JSON response from the TopHolders API endpoint. It includes the total supply of the token and a list of top holders, each with their address, balance, alias, and contract status.

```json
{
    "totalSupply": "28247199602143667875022",
    "holders": [
        {
            "address": "0x663A5C229c09b049E36dCc11a9B0d4a8Eb9db214",
            "balance": "27830592101166458317451",
            "alias": "",
            "isContract": true
        },
        {
            "address": "0x04bDa42de3bc32Abb00df46004204424d4Cf8287",
            "balance": "281117091930974326438",
            "alias": "",
            "isContract": false
        },
        {
            "address": "0x16BCA6D06425daa0B0724086eB1e3b7D499ef403",
            "balance": "135490409046235230133",
            "alias": "",
            "isContract": false
        },
        {
            "address": "0x0000000000000000000000000000000000000000",
            "balance": "1000",
            "alias": "",
            "isContract": false
        }
    ]
}
```

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

### Honeypot API IsHoneypot Endpoint Response Example

Source: https://docs.honeypot.is/ishoneypot

This JSON object represents a sample response from the IsHoneypot endpoint. It includes detailed information about the token being checked, its trading pair, risk assessment, simulation success, honeypot status, trading simulation results, holder analysis, contract code properties, chain details, and router/pair information.

```json
{
"token": {
    "name": "USD Coin",
    "symbol": "USDC",
    "decimals": 6,
    "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
    "totalHolders": 1755847
},
"withToken": {
    "name": "Ether",
    "symbol": "ETH",
    "decimals": 18,
    "address": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
    "totalHolders": 671397
},
"summary": {
    "risk": "very_low",
    "riskLevel": 0
},
"simulationSuccess": true,
// "simulationError": "Insufficient liquidity for this trade."
"honeypotResult": {
    "isHoneypot": false
    // "honeypotReason": "PancakeSwap: TRANSFER_FROM_FAILED"
},
"simulationResult": {
    // USDC doesn't actually have maxBuy and maxSell, but this is just an example.
    "maxBuy": {
        "token": 500000,
        "tokenWei": "500000000000000",
        "withToken": 9.62705611028878,
        "withTokenWei": "9627056110288779597"
    },
    "maxSell": {
        "token": 500000,
        "tokenWei": "500000000000000",
        "withToken": 9.62705611028878,
        "withTokenWei": "9627056110288779597"
    },
    "buyTax": 0,
    "sellTax": 0,
    "transferTax": 0,
    "buyGas": "154591",
    "sellGas": "107886"
},
"holderAnalysis": {
    // NOTE: This is NOT the number of holders for the token.
    // This is only how many holders we are analyzing.
    // Look at the "token" section for the actual number of holders.
    "holders": "2",
    "successful": "2",
    "failed": "0",
    "siphoned": "0",
    "averageTax": 0,
    "averageGas": 134250.5,
    "highestTax": 0,
    "highTaxWallets": "0",
    "taxDistribution": [
        {
            "tax": 0,
            "count": 2
        }
    ]
},
"flags": [],
"contractCode": {
    "openSource": true,
    "rootOpenSource": true,
    "isProxy": true,
    "hasProxyCalls": true
},
"chain": {
    "id": "1",
    "name": "Ethereum",
    "shortName": "ETH",
    "currency": "ETH"
},
"router": "0x7a250d5630B4cF539739dF2C5dAcb4c659F2488D",
"pair": {
    "pair": {
        "name": "Uniswap V2: USDC-WETH",
        "address": "0xB4e16d0168e52d35CaCD2c6185b44281Ec28C9Dc",
        "token0": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
        "token1": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
        // Type will be either "UniswapV2" or "UniswapV3", even on Pancakeswap.
        "type": "UniswapV2"
    },
    "chainId": "1",
    "reserves0": "37345754334572",
    "reserves1": "18943616626757258383905",
    "liquidity": 74766200.17781314, // USD Value.
    "router": "0x7a250d5630B4cF539739dF2C5dAcb4c659F2488D",
    "createdAtTimestamp": "1620250931",
    "creationTxHash": "0x125e0b641d4a4b08806bf52c0c6757648c9963bcda8681e4f996f09e00d4c2cc"
},
"pairAddress": "0xB4e16d0168e52d35CaCD2c6185b44281Ec28C9Dc"
}

```

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

### GET /v2/GetContractVerification

Source: https://docs.honeypot.is/contract

Retrieves a list of contracts called by a specified contract and indicates whether they are open source. This endpoint simulates buy/sell operations to trace external contract calls.

```APIDOC
## GET /v2/GetContractVerification

### Description
This endpoint allows you to retrieve a list of contracts that get called by the contract you specify and whether they are open source or not. It performs a check on the root contract and all subsequent contracts in the call tree.

### Method
GET

### Endpoint
`/v2/GetContractVerification`

### Parameters
#### Query Parameters
- **address** (address) - Required - The address of the contract you want to check.
- **chainID** (integer) - Optional - The chain you want to check the token on. If not specified, it will try to find the most suitable chain based on liquidity.

### Request Example
```curl
curl -G https://api.honeypot.is/v2/GetContractVerification \
-H "X-API-KEY: {APIKEY}" \
-d address=0x8a50b28242a88e051a0c08b11050aae6a663493c
```

### Response
#### Success Response (200)
- **isContract** (boolean) - If the address being checked is a contract.
- **isRootOpenSource** (boolean) - If the address being checked is open source.
- **fullCheckPerformed** (boolean) - If the full check was performed. If false, summary/contractsOpenSource/contractCalls may not be present.
- **summary** (object) - A summary of the results.
  - **isOpenSource** (boolean) - If all the contracts called by the contract are open source, as well as the root contract.
  - **hasProxyCalls** (boolean) - If there are any delegatecalls made.
- **contractsOpenSource** (object) - A list of contracts that are called in the tree and if they are open source or not. Key is the contract address, value is a boolean indicating if it's open source.
- **contractCalls** (array) - A list of all unique calls made in the call tree, in no specific order.

#### Response Example
```json
{
  "isContract": true,
  "isRootOpenSource": true,
  "fullCheckPerformed": true,
  "summary": {
      "isOpenSource": true,
      "hasProxyCalls": false
  },
  "contractsOpenSource": {
      "0x8a50B28242A88e051A0C08b11050AAE6A663493C": true
  },
  "contractCalls": []
}
```
```

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

### Honeypot Flags JSON Example

Source: https://docs.honeypot.is/ishoneypot

Illustrates the 'flags' field within the /v2/IsHoneypot API response, which lists warnings or potential issues identified with a token, such as transfer restrictions or extremely high taxes. Although deprecated in favor of 'summary/flags', it remains for backward compatibility.

```json
{
    "flags": ["TRANSFER_BLOCKED", "EXTREMELY_HIGH_TAXES"]
}
```

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

### Honeypot Checks API

Source: https://docs.honeypot.is/index

Learn how to check if a token is a honeypot or not, and get the various details, such as taxes and gas for a token.

```APIDOC
## GET /check/honeypot

### Description
Checks if a token is a honeypot and provides details like taxes and gas.

### Method
GET

### Endpoint
`/check/honeypot`

### Parameters
#### Query Parameters
- **token_address** (string) - Required - The address of the token to check.
- **chain_id** (integer) - Required - The ID of the blockchain chain.

### Request Example
```json
{
  "example": "GET /check/honeypot?token_address=0x...&chain_id=1"
}
```

### Response
#### Success Response (200)
- **is_honeypot** (boolean) - True if the token is a honeypot, false otherwise.
- **taxes** (object) - Information about buy and sell taxes.
- **gas** (object) - Information about gas fees.

#### Response Example
```json
{
  "example": {
    "is_honeypot": true,
    "taxes": {
      "buy": {
        "tax": 10,
        "fee": 5
      },
      "sell": {
        "tax": 10,
        "fee": 5
      }
    },
    "gas": {
      "buy": {
        "gas_price": "10 gwei",
        "gas_limit": "210000"
      },
      "sell": {
        "gas_price": "10 gwei",
        "gas_limit": "210000"
      }
    }
  }
}
```
```

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

### USDC Example: Contract Code Data

Source: https://docs.honeypot.is/changelog

This JSON snippet illustrates the 'contractCode' object returned by the 'ishoneypot' endpoint. It includes boolean flags indicating if the contract is open source, if its root is open source, if it's a proxy, and if it has proxy calls. This data helps in understanding the nature and security of a smart contract.

```json
{
    "contractCode": {
        "openSource": true,
        "rootOpenSource": true,
        "isProxy": true,
        "hasProxyCalls": true
    }
}
```

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

### GET /v1/GetPairs - Get Pairs

Source: https://docs.honeypot.is/pairs

Retrieves a list of trading pairs for a given token address. Currently, it returns a maximum of 10 pairs. Future versions will support custom limits.

```APIDOC
## GET /v1/GetPairs

### Description
This endpoint allows you to retrieve a list of pairs for a token. Currently, the endpoint is limited to returning `10` pairs. `/v2/` Endpoint will support a user-specified limit.

### Method
GET

### Endpoint
`/v1/GetPairs`

### Parameters
#### Query Parameters
- **address** (address) - Required - The address of the token to retrieve pairs for.
- **chainID** (integer) - Optional - The chain you want to check the token on. If not specified, it will include pairs for all chains.

### Request Example
```bash
curl -G https://api.honeypot.is/v1/GetPairs \
-H "X-API-KEY: {APIKEY}" \
-d address=0x6982508145454Ce325dDbE47a25d4ec3d2311933 \
-d chainID=1
```

### Response
#### Success Response (200)
```json
[
    {
        "ChainID": 1,
        "Pair": {
            "Name": "Uniswap V2: PEPE-WETH",
            "Tokens": [
                "0x6982508145454ce325ddbe47a25d4ec3d2311933",
                "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2"
            ],
            "Address": "0xa43fe16908251ee70ef74718545e4fe6c5ccec9f"
        },
        "Reserves": [
            2309863147202366390632917740976,
            3657182645473588411835
        ],
        "Liquidity": 13795258.656990923,
        "Router": "0x7a250d5630b4cf539739df2c5dacb4c659f2488d"
    }
    // The remaining 9 pairs...
]
```
```

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

### Authenticate Honeypot API using cURL with Form Parameter Authorization

Source: https://docs.honeypot.is/authentication

This snippet shows how to authenticate with the Honeypot API using cURL by passing the API key as a form parameter 'apiKey'. While functional, this method is not recommended for security reasons. Replace '{APIKEY}' with your actual API key.

```bash
curl https://api.honeypot.is/v2/IsHoneypot \
  -d "apiKey={APIKEY}" \
  -d "address=0x0"
```

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

### IsHoneypot Endpoint - Header Authorization

Source: https://docs.honeypot.is/authentication

This endpoint checks if a given address is a honeypot. Authorization can be done via the X-API-KEY header.

```APIDOC
## GET /v2/IsHoneypot

### Description
Checks if a given address is a honeypot. API keys are required for authentication.

### Method
GET

### Endpoint
/v2/IsHoneypot

### Parameters
#### Header Parameters
- **X-API-KEY** (string) - Required - Your API key for authentication.

#### Query Parameters
- **address** (string) - Required - The address to check.

### Request Example
```json
{
  "url": "https://api.honeypot.is/v2/IsHoneypot?address=0x0",
  "method": "GET",
  "headers": {
    "X-API-KEY": "{APIKEY}"
  }
}
```

### Response
#### Success Response (200)
- **is_honeypot** (boolean) - Indicates whether the address is a honeypot.
- **reason** (string) - Explanation if it is a honeypot.

#### Response Example
```json
{
  "is_honeypot": true,
  "reason": "Contract has high transaction fees."
}
```
```

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

### GET /v1/TopHolders

Source: https://docs.honeypot.is/topholders

Retrieves the top 50 holders for a specified token. The premium API allows retrieving more holders.

```APIDOC
## GET /v1/TopHolders

### Description
This endpoint retrieves the top 50 holders for the specified token. Premium API allows retrieving more holders.

### Method
GET

### Endpoint
/v1/TopHolders

### Parameters
#### Query Parameters
- **address** (address) - Required - The address of the token to retrieve pairs for.
- **chainID** (integer) - Required - The chain you want to check the token on.

### Request Example
```curl
curl -G https://api.honeypot.is/v1/TopHolders \
-H "X-API-KEY: {APIKEY}" \
-d address=0xe786c0da51a21c8f7ec91c9889e2df3f21ee1747 \
-d chainID=1
```

### Response
#### Success Response (200)
- **totalSupply** (string) - The total supply of the token.
- **holders** (array) - An array of holder objects.
  - **address** (string) - The address of the holder.
  - **balance** (string) - The balance of the holder.
  - **alias** (string) - The alias of the holder (if any).
  - **isContract** (boolean) - Indicates if the holder address is a contract.

#### Response Example
```json
{
    "totalSupply": "28247199602143667875022",
    "holders": [
        {
            "address": "0x663A5C229c09b049E36dCc11a9B0d4a8Eb9db214",
            "balance": "27830592101166458317451",
            "alias": "",
            "isContract": true
        },
        {
            "address": "0x04bDa42de3bc32Abb00df46004204424d4Cf8287",
            "balance": "281117091930974326438",
            "alias": "",
            "isContract": false
        },
        {
            "address": "0x16BCA6D06425daa0B0724086eB1e3b7D499ef403",
            "balance": "135490409046235230133",
            "alias": "",
            "isContract": false
        },
        {
            "address": "0x0000000000000000000000000000000000000000",
            "balance": "1000",
            "alias": "",
            "isContract": false
        }
    ]
}
```
```

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

### USDC Example: Token Data with Total Holders

Source: https://docs.honeypot.is/changelog

This JSON snippet demonstrates the 'token' object within the 'ishoneypot' endpoint response. It includes standard token information like name, symbol, decimals, and address, along with the newly added 'totalHolders' field, providing insight into the token's distribution. This data is useful for analyzing tokenomics.

```json
{
    "token": {
        "name": "USD Coin",
        "symbol": "USDC",
        "decimals": 6,
        "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
        "totalHolders": 1755864
    }
}
```

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

### API Response Honeypot Result Example

Source: https://docs.honeypot.is/ishoneypot

This JSON snippet demonstrates the 'honeypotResult' object, which details whether a token is identified as a honeypot. The 'isHoneypot' field is a boolean indicating the honeypot status. If 'isHoneypot' is true, 'honeypotReason' provides the specific reason for this classification, such as 'Insufficient liquidity'.

```json
{
  // ...
  "honeypotResult": {
    "isHoneypot": true,
    "honeypotReason": "Insufficient liquidity"
  },
  // ...
}
```

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

### IsHoneypot Endpoint - Form Parameter Authorization

Source: https://docs.honeypot.is/authentication

This endpoint checks if a given address is a honeypot. Authorization can alternatively be done by passing the API key as a form parameter.

```APIDOC
## POST /v2/IsHoneypot

### Description
Checks if a given address is a honeypot. API keys can be passed as a form parameter `apiKey`.

### Method
POST

### Endpoint
/v2/IsHoneypot

### Parameters
#### Request Body
- **apiKey** (string) - Required - Your API key for authentication.
- **address** (string) - Required - The address to check.

### Request Example
```json
{
  "url": "https://api.honeypot.is/v2/IsHoneypot",
  "method": "POST",
  "headers": {
    "Content-Type": "application/x-www-form-urlencoded"
  },
  "body": "apiKey={APIKEY}&address=0x0"
}
```

### Response
#### Success Response (200)
- **is_honeypot** (boolean) - Indicates whether the address is a honeypot.
- **reason** (string) - Explanation if it is a honeypot.

#### Response Example
```json
{
  "is_honeypot": false,
  "reason": "No issues found."
}
```
```

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

### API Response Simulation Success Example

Source: https://docs.honeypot.is/ishoneypot

This JSON snippet illustrates the 'simulationSuccess' field within an API response. A value of 'true' indicates that the simulation ran without errors. If 'simulationSuccess' is false, the 'simulationError' field would contain an error message. The presence of 'honeypotResult' and 'simulationResult' is contingent on successful simulation.

```json
{
  // ...
  "simulationSuccess": true,
  // ...
}
```

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

### Pairs API

Source: https://docs.honeypot.is/index

Learn about retrieving pair information using the Honeypot API.

```APIDOC
## GET /pairs

### Description
Retrieves information about a trading pair.

### Method
GET

### Endpoint
`/pairs`

### Parameters
#### Query Parameters
- **base_token_address** (string) - Required - The address of the base token.
- **quote_token_address** (string) - Required - The address of the quote token.
- **exchange** (string) - Required - The name of the exchange (e.g., 'uniswap_v2').
- **chain_id** (integer) - Required - The ID of the blockchain chain.

### Request Example
```json
{
  "example": "GET /pairs?base_token_address=0x...&quote_token_address=0x...&exchange=uniswap_v2&chain_id=1"
}
```

### Response
#### Success Response (200)
- **pair_address** (string) - The address of the trading pair.
- **reserve_base_token** (string) - The reserve of the base token.
- **reserve_quote_token** (string) - The reserve of the quote token.

#### Response Example
```json
{
  "example": {
    "pair_address": "0x...",
    "reserve_base_token": "1000000",
    "reserve_quote_token": "500000"
  }
}
```
```

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

### Contracts API

Source: https://docs.honeypot.is/index

Learn about leveraging our powerful system to check if a contract is truly open source.

```APIDOC
## GET /check/contract

### Description
Checks if a contract is truly open source.

### Method
GET

### Endpoint
`/check/contract`

### Parameters
#### Query Parameters
- **contract_address** (string) - Required - The address of the contract to check.
- **chain_id** (integer) - Required - The ID of the blockchain chain.

### Request Example
```json
{
  "example": "GET /check/contract?contract_address=0x...&chain_id=1"
}
```

### Response
#### Success Response (200)
- **is_open_source** (boolean) - True if the contract is open source, false otherwise.

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

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

### GET /v2/IsHoneypot

Source: https://docs.honeypot.is/ishoneypot

This endpoint checks if a token is a honeypot and returns simulation results, holder analysis, flags, and contract code information.

```APIDOC
## GET /v2/IsHoneypot

### Description
This endpoint analyzes a token to determine if it is a honeypot. It returns detailed simulation results including maximum buy/sell amounts, taxes, and gas costs. It also provides holder analysis, flags for potential risks, and contract code information such as open-source status and proxy usage.

### Method
GET

### Endpoint
/v2/IsHoneypot

### Parameters
#### Query Parameters
- **tokenAddress** (string) - Required - The address of the token to analyze.

### Response
#### Success Response (200)
- **simulationResult** (object) - Contains simulation data for buy and sell operations.
  - **maxBuy** (object) - Maximum buy simulation details.
    - **token** (number) - Amount of tokens.
    - **tokenWei** (string) - Amount of tokens in Wei.
    - **withToken** (number) - Amount received in tokens.
    - **withTokenWei** (string) - Amount received in Wei.
  - **maxSell** (object) - Maximum sell simulation details.
    - **token** (number) - Amount of tokens.
    - **tokenWei** (string) - Amount of tokens in Wei.
    - **withToken** (number) - Amount received in tokens.
    - **withTokenWei** (string) - Amount received in Wei.
  - **buyTax** (number) - Buy tax percentage.
  - **sellTax** (number) - Sell tax percentage.
  - **transferTax** (number) - Transfer tax percentage.
  - **buyGas** (string) - Gas cost for buying.
  - **sellGas** (string) - Gas cost for selling.
- **holderAnalysis** (object) - Analysis of token holders (optional).
  - **holders** (string) - The number of holders analyzed (not the total number of holders).
  - **successful** (string) - The number of holders that can sell.
  - **failed** (string) - The number of holders that cannot sell.
  - **siphoned** (string) - The number of holders whose tokens were transferred without consent.
  - **averageTax** (number) - The average tax paid by holders upon selling.
  - **averageGas** (number) - The average gas cost paid by holders upon selling.
  - **highestTax** (number) - The highest tax a holder would have to pay.
  - **highTaxWallets** (string) - The number of wallets paying >=50% tax.
  - **taxDistribution** (array) - Distribution of tax percentages among wallets.
    - **tax** (number) - Tax percentage.
    - **count** (number) - Number of wallets paying this tax.
- **flags** (array) - Warnings or flags about the token (deprecated, use summary/flags instead).
  - **(string)** - A flag indicating a potential issue (e.g., "TRANSFER_BLOCKED", "EXTREMELY_HIGH_TAXES").
- **contractCode** (object) - Information about the contract's code (optional).
  - **openSource** (boolean) - Indicates if the contract and all called contracts are open source.
  - **rootOpenSource** (boolean) - Indicates if the root token contract is open source.
  - **isProxy** (boolean) - Indicates if the contract is a proxy contract.
  - **hasProxyCalls** (boolean) - Indicates if there are any delegate calls in the execution path.

#### Response Example
```json
{
  "simulationResult": {
    "maxBuy": {
      "token": 500000,
      "tokenWei": "500000000000000",
      "withToken": 9.62705611028878,
      "withTokenWei": "9627056110288779597"
    },
    "maxSell": {
      "token": 500000,
      "tokenWei": "500000000000000",
      "withToken": 9.62705611028878,
      "withTokenWei": "9627056110288779597"
    },
    "buyTax": 0,
    "sellTax": 0,
    "transferTax": 0,
    "buyGas": "154591",
    "sellGas": "107886"
  },
  "holderAnalysis": {
    "holders": "2",
    "successful": "2",
    "failed": "0",
    "siphoned": "0",
    "averageTax": 0,
    "averageGas": 134250.5,
    "highestTax": 0,
    "highTaxWallets": "0",
    "taxDistribution": [
      {
        "tax": 0,
        "count": 2
      }
    ]
  },
  "flags": [
    "TRANSFER_BLOCKED",
    "EXTREMELY_HIGH_TAXES"
  ],
  "contractCode": {
    "openSource": true,
    "rootOpenSource": true,
    "isProxy": true,
    "hasProxyCalls": true
  }
}
```
```

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

### Verify Contract Open Source Status (cURL)

Source: https://docs.honeypot.is/contract

This cURL command demonstrates how to call the GetContractVerification endpoint to check if a specific contract address is open source. It includes the necessary API key and the contract address as parameters. The output is a JSON object detailing the verification results.

```shell
curl -G https://api.honeypot.is/v2/GetContractVerification \
-H "X-API-KEY: {APIKEY}" \
-d address=0x8a50b28242a88e051a0c08b11050aae6a663493c
```

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

### Contract Verification API Response Structure

Source: https://docs.honeypot.is/contract

This JSON object represents the response from the GetContractVerification API. It provides details on whether the queried contract is itself a contract, if it's open source, and if a full verification check was possible. It also includes a summary of all contracts in the call tree and their open-source status.

```json
{
  "isContract": true, 
  "isRootOpenSource": true, 
  "fullCheckPerformed": true, 
  "summary": {
      "isOpenSource": true, 
      "hasProxyCalls": false 
  },
  "contractsOpenSource": {
      "0x8a50B28242A88E051A0C08b11050AAE6A663493C": true
  },
  "contractCalls": []
}
```

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

### Top Holders API

Source: https://docs.honeypot.is/index

Learn about retrieving the top holders of a token using the Honeypot API.

```APIDOC
## GET /holders/top

### Description
Retrieves the top holders of a token.

### Method
GET

### Endpoint
`/holders/top`

### Parameters
#### Query Parameters
- **token_address** (string) - Required - The address of the token.
- **chain_id** (integer) - Required - The ID of the blockchain chain.
- **limit** (integer) - Optional - The maximum number of holders to return (default: 10).

### Request Example
```json
{
  "example": "GET /holders/top?token_address=0x...&chain_id=1&limit=5"
}
```

### Response
#### Success Response (200)
- **holders** (array) - A list of top holders.
  - **address** (string) - The holder's address.
  - **balance** (string) - The balance of the token.
  - **percentage** (string) - The percentage of total supply held.

#### Response Example
```json
{
  "example": {
    "holders": [
      {
        "address": "0x...",
        "balance": "1000000",
        "percentage": "5.0%"
      },
      {
        "address": "0x...",
        "balance": "500000",
        "percentage": "2.5%"
      }
    ]
  }
}
```
```
Tokens:
Raw