Skip to main content

API: Initial setup

Getting ready to request ReadPartner API data.

  1. Once you have an API account, navigate to https://app.readpartner.com/api-dashboard/api-keys. Then input your desired API key name and click "Generate new key".

  2. After your new key has been generated, click "Copy" in the API key block.

  3. Provide this API key with your API request in the X-API-Key header, as shown in the example:

python

import requests

API_KEY = "YOUR_API_KEY"
API_URL = "https://app.readpartner.com/api-dashboard/api/v1/monitoring"

headers = {
"X-API-Key": API_KEY,
}

resp = requests.get(API_URL, headers=headers)

Questions? Feel free to reach out to your account manager or via support chat.

Did this answer your question?