Skip to main content
Using the Nightwatch API

How to start using the Nightwatch API to build your own system.

Maja Nagelj avatar
Written by Maja Nagelj
Updated over 2 months ago

Nightwatch’s API capabilities offer powerful options for users looking to generate custom reports, build external systems using the rich data available within the app, and automate complex tasks.

This is particularly useful for those who need to perform actions that go beyond the built-in features of the Nightwatch platform. By leveraging simple Python scripts, you can seamlessly integrate Nightwatch data into your own workflows.

Note: The API feature is only available for accounts tracking more than 1000 keywords.

Why Use the Nightwatch API?

  • Custom Reporting: The Nightwatch API allows you to extract data directly from the platform, enabling you to create custom reports tailored to your specific needs. This flexibility is ideal for users who require more advanced reporting features than those available within the app.

  • Building External Systems: If you need to incorporate Nightwatch data into an external system, the API makes it easy to pull and manipulate this data. Whether you are developing a dashboard, integrating with another application, or creating automated processes, the API provides the tools you need.

  • Automation with Python Scripts: With simple Python scripts, you can automate tasks such as bulk tagging keywords or generating reports. These scripts can be executed locally or within cloud-based environments like Jupyter Notebooks or Google Colab, making it convenient to run and maintain.


Generating your API key

To start using the Nightwatch API, you first need to generate an API key. Please note that the API feature is only available for accounts tracking more than 1,000 keywords.

Steps to Generate Your API Key:

  1. Click the user icon at the top-right corner of the Nightwatch dashboard.

  2. Select "Settings" from the dropdown menu.

  3. Click on "API access."

  4. Generate your API key.

Screen Recording 2021-06-24 at 12.54.06.35 PM

Start using our API

Once you have your API key, you can begin integrating Nightwatch data into your systems.

Our comprehensive API documentation is available here:


Nightwatch API Examples

To help you get started, we have created a collection of example scripts that you can find in our GitHub repository. These scripts are designed to showcase various ways you can leverage the Nightwatch API.

Feel free to explore and modify them to fit your needs:



Did this answer your question?