---
url: https://docs.dataflair.ai/guide.md
description: >-
  What this documentation covers, who it is for, and where the shared
  conventions live.
---

# Introduction

This is DataFlair's public documentation site. It covers the integration surfaces of three
products:

* **[DataFlair.ai](/dataflair/)**: the Toplist API, the WordPress plugin, and the Jira and HubSpot
  integration guides. Reference material for building an integration against DataFlair's APIs from
  outside this codebase, in any stack.
* **[Stats](/stats/)**: affiliate tracking. Postbacks, the Operator Reporting API, tracking links
  and testing tools.
* **[Marketplace](/marketplace/)**: selling ad inventory. Ad tags, ad server connections and the
  Custom Ad Server API.

This Guide section covers the conventions of the Toplist API: how authentication works and how errors
are reported. Stats postbacks and the Marketplace Ad Server API work differently, so each has its own
authentication and error pages under its product. For the concrete endpoints, request/response shapes,
and integration details of a specific API, go to the page for that product.

## Who this is for

The motivating case for the API docs is a developer building an integration against DataFlair's
Toplist API from outside this codebase. DataFlair does not ship a client library in any language.
You build your own HTTP client against the plain-JSON contract documented here. Nothing on this site
assumes any particular stack or language. Examples are `curl` (a raw HTTP request) or plain pseudocode
(an algorithm you implement yourself), and a few pages also show PHP, Node or Python.