Ptolemy API documentation
Everything you need to integrate with Ptolemy’s financial data management platform. Create instruments, manage time series, query markets, and automate your data pipelines using robot tokens and a consistent REST API.
Instruments →
Define instrument types with custom fields, create and query instruments, and organise with hierarchical tags.
Time Series →
Store scalar and composite time series values against instruments. Supports typed schemas and per-value custom fields.
Markets →
Model exchanges, listing venues, calendars, listing statuses, and trading suspensions.
Events & Webhooks →
Subscribe to real-time change notifications. Query the event log for audit trails.
Import & Export →
Bulk import instruments and data via ZIP archive. Export any resource type to CSV or JSON asynchronously.
Workspaces & Members →
Create workspaces, invite human members, provision robot users, and manage API tokens.
Quick start
Get from zero to your first API call in under five minutes.
Create a robot user
In your workspace settings, go to API Tokens and create a new robot user. Copy the token — it’s only shown once.
Make your first request
All requests require the Authorization: Bearer <token> header and target https://api.ptolemy.cloud/v1/.
List your instruments
Try GET /v1/workspaces/:workspaceId/instruments to see what’s in your workspace.
https://api.ptolemy.cloud/v1All endpoints prefixed with
/v1 and scoped to a workspace.:id params resolve as either a UUID or a user-supplied identifier/slug.limit (default 50, max 200) and after from meta.next_cursor.?archived=true for archived only, ?archived=all for both. Default is active only.?ids=aapl,msft,uuid on any list endpoint to fetch specific records.{"detail": "..."}. Common codes: 400, 401, 403, 404, 409, 422.