API Documentation

On the Premium Wallet API documentation page, you will find all the necessary information and explanations of our API to easily integrate with a new or existing faucet or website.

The following information is intended for Developers

API Methods

Using our API is easy, as every request you make is a HTTP POST request with a set of parameters (JSON objects) such as your API / Secret key and currency.
If the request was successful, the result returned in JSON format which will contain a status attribute equal to 200 along with a message attribute indicates the API call is "Success" and a result attribute showing the additional result information associated with the API endpoint. If the request failed, you will get a status attribute equal to 4xx (e.g. 429) along with a message attribute indicates the API call was having "Error" and a result attribute explaining the error in further detail (e.g. Invalid API Key / Secret Key).

Avoiding excessive API requests

In order to keep the service running smooth, and for your users to have an enjoyable experience, we ask that you limit the number of API requests sent from your website/application. Below are a few tips and tricks for doing this.

Don't send a request for data you already have/was given

The best example of this is getbalances. There's no need to call it excessively, as the balance is returned in the send API result. The best way to use this is to store it in your database each time you made a payout to avoid sending another getbalances request.

The other example of this is checkuser. If you already checked a user, don't check it again. Store the check result in a database and query that before making the API call.

example fields for your database: user_id, valid_result, time_checked, user_hash

Don't send requests from public-facing pages

This means, don't use code which calls the API from a page that the user has control of e.g. withdraw, home page, etc. This is the most common cause for using up your API request limit very quickly.

Again getbalances and send come to mind here, as most faucet scripts tend to place a getbalances call on their home page causing a lot of API requests to be sent. This is a bad practise and should be avoided. A better way is to follow the example from the previous section and store the balance in the database after a payout has been made.

Use background processes/cron jobs

The better way to make API calls is via background processes, also known as cron jobs. These tasks can be set up to run once per minute (or any interval you like) and run a command or PHP script. We highly recommend the use of them for the following tasks:

Storing the balances information in the database with a getbalances API call.
Bulk processing a withdraw queue of user payouts instead of sending directly from the withdraw page. This is much more secure and prevents spam/race conditions/double pays.

The above tips and tricks will help you to limit the amount of API requests that your script/website/application makes, resulting in a more secure and faster website for your users.