01Documentation
Four self-contained contracts.
One per product. None depends on a shared gateway, none needs the other three to respond.
02Authentication
The key is presented in the X-Cle-API header. It's specific
to one product: a Places key doesn't open Jobs.
curl -H "X-Cle-API: rf_…" "https://places.rankfabrik.com/villes"03What every response carries
| Header or field | Meaning |
|---|---|
x-appel-facture | oui or non. A call with no result is never billed. |
x-unites-restantes | What's left of the month's quota. Absent if the plan has none. |
mesures | Duration, bytes collected, units billed for that specific call. |
completude | The actually filled share of each field, as a percentage. |
motif | Set when the list is empty. Distinguishes an area with no results from a refusal by the source. |
truncated | On sweeps: the time budget was reached before the grid finished. |
04Status codes
| Code | Cause |
|---|---|
400 | A parameter is missing or contradictory. The message says which one. |
401 | Key missing, unknown, or revoked. |
404 | Unknown route. The response lists the ones that exist. |
429 | Quota exhausted. Nothing is billed past that point. |
05The four addresses
| Product | Host | Billable unit |
|---|---|---|
| Places | https://places.rankfabrik.com |
place returned |
| Jobs | https://jobs.rankfabrik.com |
posting returned |
| Captions | https://captions.rankfabrik.com |
transcript returned |
| Verify | https://verify.rankfabrik.com |
address settled |
Full OpenAPI files are provided on request at contact@rankfabrik.com, and published on the marketplaces where the products are distributed.