Overview

The QuickNode Console API allows users to perform all actions available in the User Dashboard programmatically via REST API. These actions include:

1. Creating, managing, and deleting endpoints
2. Retrieving metrics and billing information
3. Managing and rotating API keys
4. Configuring security features (e.g., whitelisting, JWT authentication, and more)

Access

The Console API is available to accounts subscribed to paid plans.

Authentication

To use the Console API, you must authenticate your requests by including an API key in the HTTP headers. Follow these steps:

1. Generate an API key from your QuickNode dashboard.
2. Include the API key in the x-api-key header of your HTTP request. For example:

x-api-key: your-api-key-here

Here's an example of how to request usage data using the Console API with cURL:

curl -X GET 'https://api.quicknode.com/v0/usage/rpc' \
     -H 'accept: application/json' \
     -H 'x-api-key: YOUR_API_KEY_HERE'

Prometheus/OpenMetrics Exporter (Enterprise Exclusive)

Enterprise customers now have access to two dedicated endpoints— Prometheus (/exporter/prometheus) and OpenMetrics (/exporter/openmetrics) —for deeper insights into their API usage. These endpoints provide real-time metrics that can be seamlessly integrated into internal dashboards. They offer the same data as the metrics dashboard, updated at intervals defined by QuickNode, and are compatible with any Prometheus scraper. This enables easy monitoring and tracking of usage metrics with accuracy.

Note

Please note that these two endpoints are currently available only for Enterprise customers. For more information or inquiries about accessing these endpoints, feel free to contact us.

Making Console REST API Requests

In this documentation, you will see example requests made with cURL and various programming languages for each supported Console API method. This section will explain how to execute it on your machine.

cURL

Most *nix based systems have cURL support out of the box. cURL is a command line tool and library for transferring data with URLs. Check if you have it by running the following:

curl -h

Python

To run our Python code examples, you'll need to have Python installed as well as the requests package. You can install this package with the following command:

python -m pip install requests

JavaScript

To run our JavaScript code examples, you'll need to have Node v18 and up installed. You can follow this official document to install the latest, stable version of Node globally. Check if you have it by running the following:

node -v

Ruby

To run our Ruby code examples, you'll need to have Ruby installed. You can follow this official installation document for more information. Check if you have it by running the following:

ruby -v

We ❤️ Feedback

We value your feedback! Please take a few minutes to complete our Console API feedback form and share your thoughts with us.