API documentation

The Draftable API is complemented by detailed documentation which provides information on the many facets of the API and its endpoints. For the most up to date documentation, see below for further information.

The reference pages linked below describe the Draftable Compare API itself — its endpoints, parameters and behaviour. That API surface is shared by the cloud API and API Self-Hosted, so this material is current and applies to both.

Only the deployment model differs by version.

If you are deploying API Self-Hosted, Version 2 is legacy.

All new self-hosted deployments must use Version 3, which features a modern multi-container architecture with improved security and performance.

👉 Get started with API Self-Hosted v3

Using the cloud API at api.draftable.com? Start with Getting started with the Draftable API, or explore the endpoints interactively with the API Explorer.

Introduction to the Draftable API

https://api.draftable.com/introduction

Overview of the comparison lifecycle

https://api.draftable.com/reference/comparison-lifecycle

Creating comparisons

https://api.draftable.com/reference/creating-comparisons

The comparison viewer

https://api.draftable.com/reference/comparison-viewer

Performance and comparison speeds

https://api.draftable.com/reference/comparison-speeds

Exporting comparisons

https://api.draftable.com/reference/exporting-comparisons

Authentication with the API

https://api.draftable.com/reference/authentication