DOCUMENTATION
Build on the City OS. Technical guides, schema definitions, and API references for integrating OpenData.London into your stack.
GETTING STARTED
Choose your path
Two distinct entry points for the two types of technical users.
For Data Engineers (Snowflake)
[ MOUNT THE SHARE ]
How to accept the Secure Data Share and mount the LONDON_DB database into your Snowflake account.
- Prerequisites
- Zero-Copy Architecture
- RBAC & Governance
MOUNT THE SHARE
For Software Engineers (API)
[ GET AN API KEY ]
Generate a Bearer Token and make your first GraphQL or REST request.
- Authentication
- Rate Limits
- SDKs (Python, Node, Go)
GET AN API KEY
PRODUCT GUIDES
- Schema Reference: Complete dictionary of all 6,000+ tables, views, and columns.
- Entity Resolution: How we link UPRNs, Company Numbers, and Title Numbers.
- Time Travel: Querying historical states using AT and BEFORE clauses.
- Native App Installation: How to install the Alliela app container in your account.
- Prompt Engineering: Best practices for querying the graph with natural language.
- Security Context: Configuring row-level access policies for the agent.
- Webhook Events: Payload schemas for insolvency_alert, planning_alert, and director_change.
- Rule Configuration: Writing custom SQL triggers for your watchlists.
- Security: IP whitelisting and signature verification.
- Protocol: How the double-blind matching works.
- Input Formatting: Preparing your CSVs for the clean room (hashing requirements).
- Privacy Guarantees: The cryptographic proof of zero-trust.
NEED SUPPORT?
Enterprise Support
Customers with an Enterprise License have access to a dedicated Slack channel with our engineering team.
JOIN SLACK CHANNEL