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/{{chainId}}/{{hookAddress}}

GET

When users want to investigate a specific hook, this endpoint provides comprehensive information. A DeFi protocol could use this to perform automated due diligence before integrating a hook.

{
  "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 NoOp
      "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
}
Previous/api/public/v1/uniswap/hooks/{{chainId}}/{{hookAddress}}Next/api/public/v1/uniswap/hooks/{{chainId}}/{{hookAddress}}/contract-metadata

Last updated 2 months ago