In the rapidly evolving world of decentralized finance (DeFi), access to accurate, real-time data is crucial for developers, investors, and platforms building next-generation financial solutions. The Query Protocol List API by OKX Web3 provides a streamlined way to retrieve essential information about DeFi protocols and their associated investment products. Whether you're integrating DeFi analytics into your application or building a portfolio tracker, this API delivers structured, actionable data with minimal overhead.
This guide dives deep into the functionality, use cases, and technical specifications of the Query Protocol List API, ensuring you can leverage it effectively within your Web3 development stack.
Understanding the Query Protocol List API
The Query Protocol List API serves as a foundational endpoint in the OKX WaaS (Wallet as a Service) and Web3 API suite. It allows users to fetch concise metadata about available DeFi protocols and their investment offerings. If no filtering parameters are provided, the API returns a comprehensive list of all supported protocols—making it ideal for discovery and exploratory applications.
Each response includes key identifiers, network details, and URL templates for accessing further investment data—both programmatically and through the OKX web interface.
Key Use Cases
- DeFi Aggregators: Build dashboards that compare yield opportunities across multiple protocols.
- Portfolio Trackers: Identify which protocols a user has interacted with based on known investment IDs.
- Developer Tooling: Auto-generate documentation or SDKs using dynamic protocol metadata.
- Market Research: Analyze protocol distribution across chains and networks.
🔧 API Endpoint and Request Structure
The API uses a simple GET request model, making it easy to integrate without complex authentication flows during initial exploration.
Request URL
GET https://web3.okx.com/api/v5/defi/explore/protocol/listThis endpoint is publicly accessible and returns JSON-formatted responses containing protocol and product metadata.
Optional Query Parameters
You can filter results using one or both of the following optional parameters:
| Parameter | Location | Type | Description |
|---|---|---|---|
platformId | Query | String | Unique identifier for a protocol |
platformName | Query | String | Official name of the platform |
👉 Discover live protocol data with powerful Web3 tools
For example:
GET https://web3.okx.com/api/v5/defi/explore/protocol/list?platformName=AaveReturns information specifically related to Aave.
If no parameters are passed, the API returns data for all available protocols, enabling full ecosystem visibility.
📤 Response Format and Data Fields
The response contains an array of protocol objects, each including platform-level details and nested investment product information.
Top-Level Response Fields
platformId: Unique string identifier for the DeFi platform.platformName: Official public name (e.g., "Uniswap").platformWebSite: Official website URL of the protocol.investmentApiUrlPattern: Template URL for retrieving detailed investment data via API.investmentPageUrlPattern: UI-facing URL pattern on OKX for viewing investment details.platformMinInfos: Array of structs containing granular investment product data.
Nested Investment Product Fields (platformMinInfos)
Each item in the platformMinInfos array includes:
investmentId: Identifier for a specific investment product.protocolId: Links back to the parent protocol.network: Human-readable network name (e.g., Ethereum Mainnet).chainId: Standardized chain ID (e.g.,1for Ethereum).
This structure enables precise mapping between protocols, products, and blockchain networks—critical for cross-chain applications.
✅ Example Usage Scenarios
Let’s walk through practical implementations:
Scenario 1: Fetch All Protocols
To retrieve every supported protocol:
GET https://web3.okx.com/api/v5/defi/explore/protocol/listUseful for:
- Initializing a protocol selector dropdown
- Auditing protocol coverage across chains
Scenario 2: Search by Platform Name
Looking for information about Compound?
GET https://web3.okx.com/api/v5/defi/explore/protocol/list?platformName=CompoundIdeal for:
- Building branded landing pages
- Integrating protocol-specific analytics
Scenario 3: Locate Investment Details via URL Patterns
From the response:
"investmentApiUrlPattern": "https://web3.okx.com/api/v5/defi/investment/detail?investmentId={investmentId}"Replace {investmentId} with an actual ID to fetch detailed metrics like APY, TVL, or user positions.
👉 Access real-time DeFi data seamlessly with advanced API tools
🔍 Core Keywords for SEO Optimization
To align with user search intent and improve discoverability, these keywords are naturally integrated throughout:
- DeFi API
- Web3 API
- Protocol list
- Investment products
- OKX Web3
- Blockchain protocols
- Chain ID
- WaaS API
These terms reflect high-volume queries from developers and fintech builders exploring DeFi integration options.
❓ Frequently Asked Questions (FAQ)
Q: Is authentication required to use this API?
A: For read-only endpoints like the Query Protocol List API, no authentication is needed during early development. However, rate limits may apply. For production use or private data access, API keys and signatures will be required.
Q: Can I filter results by blockchain network?
A: Not directly through query parameters. You must retrieve the full list (or filtered by platform) and parse the network or chainId fields within platformMinInfos on the client side.
Q: How often is the protocol list updated?
A: The dataset is refreshed regularly to include newly integrated protocols and remove deprecated ones. It reflects current offerings on OKX Web3 and DeFi services.
Q: What does investmentApiUrlPattern mean?
A: It's a templated URL where {investmentId} should be replaced with an actual ID from the response. This gives direct access to real-time investment performance data.
Q: Is there support for testnets or sandbox environments?
A: Currently, the API focuses on mainnet protocols. Sandbox environments may be available in future WaaS updates—check official OKX documentation for announcements.
Q: Are there rate limits?
A: Yes. Public endpoints have throttling in place to ensure system stability. High-frequency applications should implement caching and respect HTTP retry headers.
👉 Unlock powerful Web3 capabilities with developer-first tools
Final Thoughts
The Query Protocol List API is more than just a directory—it's a gateway to understanding the DeFi landscape programmatically. With clean, well-documented responses and flexible querying options, it empowers developers to create intelligent applications that adapt to changing market conditions.
Whether you're building a yield optimizer, cross-chain bridge monitor, or educational platform, leveraging this endpoint lays the groundwork for scalable, data-driven Web3 experiences.
By combining SEO-rich content with practical implementation guidance, this resource ensures both visibility and utility for technical audiences navigating the future of finance.