# GET

Main endpoint of our API, which returns a paginated list of **Uniswap V4** hooks with detailed information. Hooks can be queried with such parameters:

* **page** & **limit**: control pagination of results
* **search**: filter hooks by address
* **chainId**: filter hooks by specific network
* **isVerified**: return only hooks with etherscan-verified code
* **poolPair**: filter hooks by pools with specific token trading pairs
* **sort**: parameter to sort response in format: *?sort=property:(asc|desc)*, allowed: **name**, **deployedAt**, **volumeBaseCurrency**, **feeBaseCurrency**, **tvlBaseCurrency**

<pre class="language-json"><code class="lang-json">{
  "data": [
    {
      "id": 0,                     // Internal identifier for the hook
      "name": "string",            // Human-readable name of the hook
      "description": "string",     // Detailed description of hook's purpose and functionality
      "address": "string",         // On-chain contract address of the hook
      "isVerified": true,          // Whether hook has passed verification process
      "isProxy": true,             // Whether hook uses proxy pattern for upgrades
      "deployerAddress": "string", // Address that deployed the hook contract
      "network": {                 // Network details where hook is deployed
        "chainId": 0,              // Chain identifier (e.g., 1 for Ethereum)
        "name": "string"           // Network name (e.g., "Ethereum", "Base")
      },
      "isNoOp": true,              // Whether hook is considered <a data-footnote-ref href="#user-content-fn-1">NoOp</a>
      "deployedAt": "string",      // Timestamp of hook deployment
      "successRate": 0,            // Percentage of successful hook executions
      "tvl": {                     // <a data-footnote-ref href="#user-content-fn-2">Total Value Locked</a> in hook's pools
        "amount": "string",   
        "currency": "string"  
      },
      "totalEarning": {            // <a data-footnote-ref href="#user-content-fn-3">Total earnings</a> generated by hook
        "amount": "string", 
        "currency": "string"  
      },
      "totalVolume": {             // <a data-footnote-ref href="#user-content-fn-4">Total trading volume</a> through hook
        "amount": "string",       
        "currency": "string"  
      }
    }
  ],
  "status": "success",             // API response status
  "timestamp": "string"           // Timestamp of the API response
}
</code></pre>

This endpoint is particularly useful for building hook explorers or analytics platforms. For example:

* A DeFi dashboard could filter for verified on chainscan hooks (*isVerified = true*) with high success rates to recommend to users
* A trading platform could search for hooks supporting specific token pairs using the **poolPair** filter
* A security platform could analyze hooks by sorting them based on success rates and deployment dates
* Analytics tools could track TVL and volume trends across different networks using the **chainId** filter

The comprehensive metadata provided allows for detailed analysis of hook performance, security, and adoption across the **Uniswap V4** ecosystem.

[^1]: [noop-hooks](https://hookrank.gitbook.io/hookrank/hooks-knowledge/noop-hooks "mention")

[^2]: [total-value-locked](https://hookrank.gitbook.io/hookrank/core-features/total-value-locked "mention")

[^3]: [earnings-analytics](https://hookrank.gitbook.io/hookrank/core-features/earnings-analytics "mention")

[^4]: [transaction-volume](https://hookrank.gitbook.io/hookrank/core-features/transaction-volume "mention")