LogoLogo
  • HOOKRANK
    • Introduction
  • CORE FEATURES
    • Dashboard
      • Hook List
      • Hook Details
    • Earnings Analytics
    • Gas Spendings
    • Total Value Locked
    • Transaction Volume
  • HOOKS KNOWLEDGE
    • NoOp Hooks
  • HookRank indexing
    • Events
      • Swap
      • Initialize
      • ModifyLiquidity
    • Tracked Data
  • PUBLIC API
    • Introduction
    • Endpoints
      • /api/public/v1/uniswap/hooks/networks
        • GET
      • /api/public/v1/uniswap/hooks/currencies
        • GET
      • /api/public/v1/uniswap/hooks
        • GET
      • /api/public/v1/uniswap/hooks/{{chainId}}/{{hookAddress}}
        • GET
      • /api/public/v1/uniswap/hooks/{{chainId}}/{{hookAddress}}/contract-metadata
        • GET
  • GUIDES
    • FAQs
    • How To Provide Custom Hook Integration Data
  • EXTERNAL LINKS
    • Twitter / X
    • GitHub
    • Discord
    • Brand Kit
Powered by GitBook
On this page
  1. PUBLIC API
  2. Endpoints
  3. /api/public/v1/uniswap/hooks

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

{
  "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 
      "deployedAt": "string",      // Timestamp of hook deployment
      "successRate": 0,            // Percentage of successful hook executions
      "tvl": {                     //  in hook's pools
        "amount": "string",   
        "currency": "string"  
      },
      "totalEarning": {            //  generated by hook
        "amount": "string", 
        "currency": "string"  
      },
      "totalVolume": {             //  through hook
        "amount": "string",       
        "currency": "string"  
      }
    }
  ],
  "status": "success",             // API response status
  "timestamp": "string"           // Timestamp of the API response
}

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.

Previous/api/public/v1/uniswap/hooksNext/api/public/v1/uniswap/hooks/{{chainId}}/{{hookAddress}}

Last updated 2 months ago