Nimiq Public JSON-RPC

Free rate-limited JSON-RPC access to a Nimiq Proof-of-Stake History node

Connecting

Connect to the server at this very URL! https://rpc.nimiqwatch.com

Websocket connections are not (yet) supported, you need to use individual POST requests.

Rate Limiting

Access is rate-limited by IP. Each IP has an allowance of 20 tokens per 10 seconds (subject to change).

Requests consume tokens based on the length of their result. Single results consume 1 token, list results consume 1 token per started 100 items.

For Example

Requesting the current head block produces a single result and consumes 1 token. Requesting a list of transactions for an account consumes 1 token per started 100 items, so if you limit your result to max: 100, it still only consumes 1 token. Not specifying the max parameter can consume up to 5 tokens, as the default for that parameter is 500. If the request returns 305 items, it consumes 4 tokens.

Response Headers

Each server response contains headers that tell you how many tokens you have left and when the rate limit resets:

When you have no more tokens remaining in the current time window, the server responds with a 429 Too Many Requests status code and a properly formatted error response.

Uptime

Uptime is not guaranteed. The server may be restarted or be taken offline at any time without notice.

Methods

Not all RPC methods are available. Methods that can upload, manage, or sign with stored private keys are disabled.

Available methods:

See nimiqhub.com/docs/rpc for documentation of these methods.


Contact: soeren@nimiq.com