How to start

All requests to the Quentrade API require authentication unless explicitly stated.

Get Your Quentrade API Key

We offer two ways to generate an API Key:

1System generated
2Self-generated using an RSA asymmetric encryption method

Pro Tip: We recommend the second method as it provides a more secure connection for your apps.

Create Signature

SIGNED endpoints require an additional Signature header to ensure the authenticity of the request.

Signed Endpoint

To authenticate, pass your Quentrade API Key and the Signature header in the request.

Test authentication

The quickest way to test your authentication setup is by sending a request to the /api/v1/auth/validate endpoint. This endpoint verifies the validity of your API credentials and returns the status of your authentication.

GET/api/v1/auth/validate

Permission: NoneSecurity: SIGNED

Request Headers

APIKEYstring required

Your public Quentrade API Key generated from the developer dashboard or self-generated via RSA.

Signaturestring required

The HMAC SHA256 hexadecimal hash or RSA digital signature calculated for this request.

Example Request

test_auth_endpoint.sh

curl -X GET 'https://quentrade.com/api/v1/auth/validate' \
  -H 'APIKEY: your_api_key_here' \
  -H 'Signature: your_computed_signature_here'

Response

If successful, Quentrade returns 200 OK:

auth_success_200.json

200 OK

{
  "valid": true
}

If authentication fails, Quentrade returns 401 Unauthorized:

auth_error_401.json

401 UNAUTHORIZED

{
  "error": "signature_invalid",
  "error_description": "Provided signature is invalid"
}

Previous Security and Permission Types NextGet an API key