Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.paritydeals.com/llms.txt

Use this file to discover all available pages before exploring further.

ParityDeals API uses API keys to authenticate requests. All API requests must be made over HTTPS; calls made over plain HTTP will fail. API requests without authentication will also fail.

API Keys

ParityDeals provides two types of API keys for different use cases.

Client API Key

Used for frontend applications where the key is publicly accessible.

Server API Key

Used for backend implementations. This key has more privileges and must be kept secret.
Important Security Notice: Do not share your Server API Key in any publicly accessible areas such as frontend code, client-side applications, or public repositories.

Obtaining Your API Key

You can get your API key from the ParityDeals application dashboard.
  1. Navigate to Settings.
  2. Go to the Developers section.
  3. Copy your Server API Key to use in your application.

Authorization

To authenticate your requests, pass your Server API Key as a Bearer token in the Authorization header.
Authorization: Bearer YOUR_API_KEY