OpenAPI spec

The public API publishes a machine-readable OpenAPI 3.1 description of every endpoint, parameter, and response shape. Point your client generator, Postman/Insomnia, or any OpenAPI tool at it:

https://api.ardent.africa/public/v1/openapi.json

No key is needed to fetch the spec.

What's in it

• Every GET endpoint under /public/v1, with its path and query parameters.
• A named schema for each resource (Campaign, Petition, Event, MarketplaceListing, BlogPost, Profile, Stats, …) and for the error envelope.
• The x-api-key security scheme (optional — keyless requests use the lower rate tier).

The spec is generated from the same response projections the API actually returns, so it never drifts from live behaviour.

Generate a client

# Example: a TypeScript client with openapi-typescript
npx openapi-typescript https://api.ardent.africa/public/v1/openapi.json -o ardent.d.ts

# Example: a typed SDK with openapi-generator
openapi-generator-cli generate \
  -i https://api.ardent.africa/public/v1/openapi.json \
  -g typescript-fetch -o ./ardent-sdk

Stability

Object schemas are open: per our versioning policy we may add new fields within v1, so generate your client to ignore unknown properties. Fields are never removed or retyped within a version.

Last updated: 28 June 2026