Quick Start

Getting Started with NimiqHub API

Introduction

NimiqHub API is a service designed to interact with the Nimiq blockchain. This documentation will guide you through the basic usage and setup.

Terminology

For a better understanding of the docs, here are some common terminologies:

Endpoint: The specific URL path where an API can be accessed.

HTTP Method: The type of request to be made to the endpoint (e.g., GET, POST).

Status Code: The HTTP status code returned by the API, indicating the result of the request.

Example Usage to query the latest block number

curl https://api.nimiqhub.com/getBlockNumber

Run the script and you will get the current block number from the Nimiq testnet.

Example Response

{
  "blockNumber": {
    "data": 4072103,
    "metadata": null
  }
}
Status codeDescription
200Success
400Bad request
404Not found
429Rate limit exceeded

On this page