Developer Resources

API Documentation

Integrate with TheAdBid programmatically using our API. This documentation explains the available endpoints, request formats, responses, and integration basics.

Overview

The TheAdBid API provides programmatic access to platform services and is designed for integrations, dashboards, automation, monitoring, and other applications.

API access is currently being expanded. Additional advertiser, publisher, campaign, reporting, and account endpoints will be documented as they become publicly available.

Base URL

API requests are made relative to the API base URL of your TheAdBid installation.

https://your-domain.com/api

When running TheAdBid locally, the development API is available under:

http://127.0.0.1:5000/api

Authentication

Authentication requirements depend on the endpoint. Public endpoints do not require authentication, while protected resources require an authenticated platform account or API credential.

API credentials

Keep API credentials private and never expose secret credentials in browser-side JavaScript, public repositories, or client applications.

Health Check

The health endpoint can be used to confirm that the API service is responding.

GET /health

Returns the current health status of the API.

GET /api/health

{ "status": "ok" }

Responses

API responses use JSON where applicable. Successful requests return a standard HTTP success status, while invalid or unsuccessful requests return an appropriate HTTP error status.

Status	Meaning
`200`	Request completed successfully.
`400`	The request was invalid.
`401`	Authentication is required or invalid.
`403`	The authenticated user is not permitted to perform the action.
`404`	The requested resource was not found.
`429`	Too many requests.
`500`	An unexpected server error occurred.

Errors

When an API request cannot be completed, the response may contain an error message describing the problem. Clients should always handle non-2xx responses safely.

{ "error": "Description of the error" }

Do not rely exclusively on the human-readable error message. Use the HTTP status code when determining how your application should handle a failed request.

Building with TheAdBid?

More API capabilities can be added as TheAdBid's developer platform expands. Keep this documentation as your reference for currently supported public endpoints.