This page will help you get started with the OpenPool API.
Welcome to the documentation for the OpenPool API! This API provides you with real-time information on your cryptocurrency balances, including DeFi staking balances and NFT holdings.
The OpenPool API is currently in Closed Beta
This API is currently in a closed beta phase and requires a token for access. If you'd like to test the API, please reach out to us for access.
To request access, please fill out this form with your name and the purpose for which you'll be using the API. We'll get back to you as soon as possible with further instructions on how to obtain a token.
Thank you for your interest in our API!
Request a Key
To get started with the OpenPool API, you'll need to have an API key. Please click here to request a key!
Authentication
To authenticate with our API, you'll need to include your API key in every API request. You can do this by adding the "Authorization" header to your requests, and setting the value to your API key.
{"Authorization": "Token <insert token here>"}
Endpoint URL
The Endpoint URL for the OpenPool API is: https://api.openpool.co
Response Formats
All API responses are returned in JSON format.
Response Status Codes
Our API may return the following status codes:
200: Success
400: Parameter Error
403: Forbidden
429: Rate Limit Exceeded
Rate Limiting
Our API is subject to rate limiting to prevent abuse. During our Closed Beta we are capping our rate limit at 10 requests per second. Production API keys will be subject to higher rate limits.
Want to Schedule An Onboarding Call?
Schedule some time to chat about Onboarding with us here
Conclusion
That's it! You now have the basics for getting started with our OpenPool API. If you have any questions, feel free to contact our support team for assistance.