# API documentation

Launch your crawls, read every report and receive your projects’ events from your own tools. A versioned JSON REST API, whose quotas follow your plan.

Base URL: `https://api.nessflow.com/v1`

## Guides

- [Quickstart](https://nessflow.com/en/developers/quickstart.md): Create a token, make your first call to the NessFlow API and launch a crawl, in a few minutes.
- [Authentication and scopes](https://nessflow.com/en/developers/authentication.md): How an API token authenticates, what its scopes allow, and how the plan and the role add to them.
- [API concepts](https://nessflow.com/en/developers/concepts.md): Team, project, campaign, crawl, reports and modules, and how the API links them.
- [Launch and follow a crawl](https://nessflow.com/en/developers/launching-crawls.md): Create a campaign, launch a crawl safely, follow its progress and know when its reports are ready.
- [Read the results of a crawl](https://nessflow.com/en/developers/reading-results.md): Issues, pages and reports of a crawl, and the comparison with the previous one.
- [Export a report](https://nessflow.com/en/developers/exports.md): Request the PDF report or the Excel workbook of a crawl, wait until it is ready and download it.
- [Receive webhooks](https://nessflow.com/en/developers/receiving-webhooks.md): Subscribe an address to events, verify every delivery, answer fast and handle retries.
- [Pagination](https://nessflow.com/en/developers/pagination.md): Walk through a long list by cursor, with no total and no skipped page.
- [Handle errors](https://nessflow.com/en/developers/handling-errors.md): The error format, the stable codes, and what to do depending on the family of the error.
- [Idempotency](https://nessflow.com/en/developers/idempotency.md): Retry a write without ever doing it twice, thanks to the Idempotency-Key header.
- [Rate limits](https://nessflow.com/en/developers/rate-limits.md): How the API rate is measured, per team and in cost units, and how to adapt to it.
- [Versions and changes](https://nessflow.com/en/developers/versioning.md): What may change in version 1 of the API without notice, and what will not.
- [Integration best practices](https://nessflow.com/en/developers/best-practices.md): The habits that make an integration safe, frugal and robust against errors.

## API reference

- [Account](https://nessflow.com/en/developers/reference/account.md): The token, its team, its plan and its consumption.
- [Projects](https://nessflow.com/en/developers/reference/projects.md): Projects (sites followed over time) and their health scorecard.
- [Campaigns](https://nessflow.com/en/developers/reference/campaigns.md): Reusable crawl configurations and their schedule.
- [Crawls](https://nessflow.com/en/developers/reference/crawls.md): Crawl runs and their results, issues and pages.
- [Recommendations](https://nessflow.com/en/developers/reference/recommendations.md): AI recommendations, global and per page.
- [Exports](https://nessflow.com/en/developers/reference/exports.md): PDF reports and Excel workbooks of a crawl, generated asynchronously.
- [Modules](https://nessflow.com/en/developers/reference/modules.md): Modules outside the health score (rankings, Search Console, backlinks, security, logs). They carry trends, never a score.
- [Webhooks](https://nessflow.com/en/developers/reference/webhooks.md): Signed outbound events (crawl finished, export ready, recommendations ready, signal detected). Managed by team owners and admins.
- [Webhook events](https://nessflow.com/en/developers/webhooks.md)
- [Error codes](https://nessflow.com/en/developers/errors.md)
- [Changelog](https://nessflow.com/en/developers/changelog.md)