Registering and getting access to the API Service only takes a few minutes - we've designed the process to be as easy as possible.
Login to OnFinality
Once you're in, go to to the API Service page.
A Quick Tour
The API Service page currently has three sections; a daily request indicator, the API key detail, and a usage graph.
Daily Request Indicator
Our API Service plans are billed based on the number of requests per day. As shown above, our free tier currently includes 500,000 requests that reset every 24 hours. This section clearly shows how many requests you have consumed in the progress bar and exactly when your daily usage count resets.
For each network, we provide you with two enpoints, an HTTPS and a Websocket connection. You can click on the Polkadot and Kusama network names above to switch between the displayed network URLs.
These URLs include your API key, which is private and unique to your account. You cannot let anyone know your API key, and you should do as much as possible to protect it and keep it secret as it is directly linked to your billing account. If you believe that your API key is in use by an unauthorized third party, then you can use the Regenerate Key button the reset it.
The usage graph shows you the volume of API requests made to your account over the last 24 hours or 30 days. You are viewing all blockchains by default, but can also filter down the request to a specific blockchain.
The next step for you is to connect to your new API service account and start developing! Take a look at an example of how to do this here.
Our API Service is currently in beta. We've got big plans for it, but please treat it as such and avoid running production applications on it.
We love to hear your feedback though, and appreciate it if you send any ideas or share your experience using the Feedback button on the right of our app - just send us a message and we'll make sure that we reply!