Authentication
How to authenticate with the Quartr API
How to generate an API key
Our API uses header-based authentication to ensure secure access. Each request to the API must include a key in the headers to verify your identity and permissions. You can create and manage your API keys through our portal.
Log In to the Portal
Access your account by logging into the Quartr Portal.
Navigate to API-keys
Once signed in, navigate to the API-keys section.
Generate a New API Key
Click the “Create New API Key” button, and set a desired validity period for the key. The new key should now appear in the list of API keys.
Use the API Key in Requests
Include this key in the request header using x-api-key as the header name.
Test the API Key
Try using your new API key by following one of our getting-started guides, or explore the API Reference for more details.
Dataset access
Your access to datasets is determined by your subscription plan. Each API key is associated with the permissions specific to your plan. Attempts to access datasets outside of your plan’s scope will result in a 403 Forbidden error.
Was this page helpful?