Docs Navigation
Current: API Overview
Open all sections
Overview
Getting Started
Role Guides
Compliance & Trust
Developer Reference
More
Home / Documentation / API Overview
API Reference Overview
This API documentation is forward-looking. Public API usage is not yet open, but the structure below defines the integration model for launch.
Status: API access is currently unavailable for general use. Endpoint paths, authentication flows, and rate limits may change before release.
Base URL and Versioning
- Planned base URL:
https://api.fractal.finance/v1 - Breaking changes increment major API version paths.
- Backwards-compatible additions may ship without version bumps.
Reference Sections
Authentication
Bearer tokens, CSRF protection, scope boundaries, and session semantics.
Endpoints
Planned resource catalog grouped by domain with request/response examples.
Webhooks
Event delivery model, retry semantics, and signature verification guidance.
Smart Contracts
On-chain references surfaced by API responses and network guidance.
Error Codes
Error object schema, HTTP status mapping, and integration handling patterns.
Launch Expectations
- REST endpoints for offerings, subscriptions, portfolio, and distributions.
- Webhook events for lifecycle and investor state transitions.
- Typed SDKs and OpenAPI specification after public launch.
- Contract references for on-chain offering tokens and controls.