Offering Manager API

Find the Offering Manager API documentation here om.bitbond.com/api/docsarrow-up-right

The Bitbond Offering Manager provides a public REST API that allows you to programmatically access your tenant's data and build custom integrations. The API follows RESTful conventions and returns JSON responses.

Generating an API Key

To use the API, you first need to generate an API key:

  1. Go to Settings in the admin panel.

  2. Scroll to the API Access section.

  3. Click Generate New API Key.

  4. Copy the key immediately — it is displayed only once and cannot be retrieved later. Store it securely.

You can generate a new key at any time. Note that generating a new key replaces the previous one — any integrations using the old key will stop working.

Authentication

Include your API key in the Authorization header of every API request:

Authorization: Bearer YOUR_API_KEY

Requests without a valid API key will receive a 401 Unauthorized response.

API Documentation (Swagger)

The full API reference is available as an interactive Swagger/OpenAPI documentation portal.

The Swagger documentation provides:

  • A complete list of all available endpoints.

  • Request and response schemas for each endpoint.

  • The ability to try out API calls directly from the browser.

  • Authentication setup instructions.

Common Use Cases

The API is useful for:

  • Building a custom investor UI — If the default landing page does not meet your design needs, use the public API to fetch offering data and build your own frontend.

  • Integrating with external systems — Sync investor data, order statuses, or offering details with your CRM, accounting software, or other tools.

  • Automating workflows — Programmatically manage offerings, check order statuses, or trigger actions based on events.

API Scope

The API covers public-facing endpoints for accessing offering data, investor information, and order management. It does not duplicate the full functionality of the admin panel — for complex configuration tasks, use the admin interface.

For the complete API reference including endpoints, parameters, and response formats, refer to the Swagger documentation.

Last updated

Was this helpful?