Documentation

English

German

English

German

Appearance

Introduction ​

This guide provides an overview of how to get started with our API.

Base URL ​

All API requests should be made to the following base URL:

https://api.pvnode.com/v1/

We enforce HTTPS for all API requests to ensure the security and integrity of data transmitted between your application and our servers.

Authentication ​

We currently offer API key authentication. JWT (JSON Web Token) authentication is planned for future releases and will be documented here when available.

API Keys ​

To authenticate your requests, you'll need to include your API key in the Authorization header of every request.

The Authorization header should be formatted as follows:

Authorization: Bearer YOUR_API_KEY

Replace YOUR_API_KEY with your actual API key.

Response Codes ​

Our API uses standard HTTP status codes to indicate the success or failure of your requests. Here are some of the most common codes you might encounter:

  • 200 OK: The request was successful.
  • 400 Bad Request: The request was malformed or invalid. This usually means there's an issue with the data you sent in the request body. Please double-check the API documentation for the correct format.
  • 401 Unauthorized: The request lacked valid authentication credentials. This usually means your API key is missing or invalid.
  • 403 Forbidden: The server understood the request but is refusing to authorize it. This might happen if you're trying to access a resource that you don't have permission to access.
  • 404 Not Found: The requested resource could not be found. This could indicate an incorrect URL or that the resource has been deleted.
  • 429 Too Many Requests: You've sent too many requests in a given amount of time. Please wait and try again.
  • 5XX Server Error: These codes indicate an error on our end (the pvnode servers). If you encounter a 5XX error, please try your request again later. If the issue persists, please contact our support team.

Rate Limiting ​

To ensure optimal performance and fair usage for all users, our API employs rate limiting. This means there's a limit on the number of requests you can make within a specific timeframe.

Rate limits are applied on a per-endpoint basis. You can find the specific rate limits for each endpoint in the API Reference documentation.

If you exceed the rate limit for an endpoint, you will receive a 429 Too Many Requests response code. Please wait before making further requests to that endpoint.