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 users on the Enterprise plan. See our pricing page for more information.

info

If you would like access to the Console API and its full range of REST API capabilities, please contact us.

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'

REST API

Below is a list of all REST API resources for interacting with the User Dashboard, organized by functionality. Each resource allows users to perform specific operations related to billing, chains, endpoint metrics, rate limits, security, endpoint management, and usage data.

Billing

These resources are used for retrieving billing information, including invoices and payments.

Method	URL	Description
GET	https://api.quicknode.com/v0/billing/invoices	Returns a list of invoices
GET	https://api.quicknode.com/v0/billing/payments	Returns a list of payments

Chains

This resource retrieves a list of all QuickNode-supported chains.

Method	URL	Description
GET	https://api.quicknode.com/v0/chains	Returns a list of chains

Endpoints

These resources create, retrieve, update, and archive QuickNode endpoints.

Method	URL	Description
POST	https://api.quicknode.com/v0/endpoints	Creates a new endpoint
GET	https://api.quicknode.com/v0/endpoints	Retrieves a list of endpoints
GET	https://api.quicknode.com/v0/endpoints/{id}	Returns info for a specific endpoint
PATCH	https://api.quicknode.com/v0/endpoints/{id}	Updates an endpoint
DELETE	https://api.quicknode.com/v0/endpoints/{id}	Archives an endpoint

Endpoint Metrics

This resource retrieves metrics for a specific QuickNode endpoint over a designated time period, including method calls, response status, method call breakdown, response status breakdown, and maximum method response time.

Method	URL	Description
GET	https://api.quicknode.com/v0/endpoints/{id}/metrics	Returns a single metric

Endpoint Rate Limits

This resource updates the rate limits for a specific QuickNode endpoint.

Method	URL	Description
PUT	https://api.quicknode.com/v0/endpoints/{id}/rate-limits	Updates rate limits

Endpoint Security

These resources manage the security settings for a specific QuickNode endpoint, including the creation and deletion of referrers, tokens, IPs, domain masks, and JWTs.

Method	URL	Description
POST	https://api.quicknode.com/v0/endpoints/{id}/security/referrers	Creates a new endpoint referrer
POST	https://api.quicknode.com/v0/endpoints/{id}/security/tokens	Creates a new endpoint authentication token
POST	https://api.quicknode.com/v0/endpoints/{id}/security/ips	Creates a new endpoint IP
POST	https://api.quicknode.com/v0/endpoints/{id}/security/domain_masks	Creates a new endpoint domain_mask
POST	https://api.quicknode.com/v0/endpoints/{id}/security/jwts	Creates a new endpoint JWT
DELETE	https://api.quicknode.com/v0/endpoints/{id}/security/jwts/{jwt_id}	Deletes an existing endpoint JWT
DELETE	https://api.quicknode.com/v0/endpoints/{id}/security/domain_masks/{domain_mask_id}	Deletes an existing endpoint domain_mask
DELETE	https://api.quicknode.com/v0/endpoints/{id}/security/referrers/{referrer_id}	Deletes an existing endpoint referrer
DELETE	https://api.quicknode.com/v0/endpoints/{id}/security/ips/{ip_id}	Deletes an existing endpoint IP
DELETE	https://api.quicknode.com/v0/endpoints/{id}/security/tokens/{token_id}	Deletes an existing endpoint token

Usage

These resources retrieve usage data, including total usage for a specified time range and usage data grouped by endpoint, method, or chain.

Method	URL	Description
GET	https://api.quicknode.com/v0/usage/rpc	Retrieves usage total for specified time range
GET	https://api.quicknode.com/v0/usage/rpc/by-endpoint	Retrieves usage data by endpoint
GET	https://api.quicknode.com/v0/usage/rpc/by-method	Retrieves usage data grouped by method
GET	https://api.quicknode.com/v0/usage/rpc/by-chain	Retrieves usage data by chain

We ❤️ Feedback

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