TheDocumentation Index
Fetch the complete documentation index at: https://docs.topograph.co/llms.txt
Use this file to discover all available pages before exploring further.
graph datapoint builds a complete ownership tree by recursively fetching shareholders across multiple countries and traversal depths. Starting from a root company, Topograph follows corporate shareholder chains (resolving each company in its local registry) to produce a full graph of entities and ownership relationships.
The result includes UBO (Ultimate Beneficial Owner) calculations based on ownership thresholds.
Example Request
How It Works
- Root fetch: Retrieves the company profile and shareholders from the root company’s registry
- Shareholder resolution: For each corporate shareholder, searches the relevant country’s registry to find the company
- Recursive traversal: Fetches shareholders for each resolved company, building the tree level by level
- UBO calculation: Identifies individuals with >25% ownership through direct or indirect chains
Traversal Limits
The graph traversal has built-in limits to control scope and cost:| Limit | Default | Description |
|---|---|---|
| Budget | Set by caller via graphMaxBudget | Maximum credit cents to spend on company lookups during traversal. The primary control for graph scope. |
| Max depth | 10 levels | Maximum depth of shareholder chain to follow |
| Max entities | 500 | Maximum total entities (companies + individuals) in the graph |
| Execution timeout | 6 hours | Safety net for stuck traversals. Should never be reached in normal operation |
stoppedReason indicating why traversal stopped.
Need higher limits? If your use case requires deeper traversals or more entities, contact us to discuss your requirements.
Stopped Reasons
Themetadata.stoppedReason field indicates how the traversal ended:
| Reason | Meaning |
|---|---|
completed | All shareholder chains were fully resolved |
budget_exhausted | The graphMaxBudget limit was reached |
max_depth_reached | Maximum traversal depth was reached |
max_nodes_reached | Maximum entity count was reached |
timeout | Execution timeout was reached (indicates a system issue) |
Response Structure
The graph result is included alongside the standard company data:Node Flags
| Flag | Type | Description |
|---|---|---|
isRoot | boolean | The company that was originally requested |
status | string | found, pending, not_found, error, placeholder, search_resolved, budget_truncated |
isUbo | boolean | Individual with >25% direct or indirect ownership |
isUboProxy | boolean | Company through which UBO ownership flows |
status: "budget_truncated" is a placeholder for a corporate shareholder the traversal did not fetch (because of graphMaxBudget, graphInteractive, or a depth/entity limit). It carries the nodeId and a cost preview, and can be passed to graphContinueFromNodeIds in a follow-up request to resume from there.
Interactive mode
SetgraphInteractive: true to fetch only the entry company and return its direct shareholders. Companies among those shareholders come back as budget_truncated placeholders so the caller decides which branches to expand. Each chip click is one fetch and one billing event.
graphInteractive and graphMaxBudget are mutually exclusive. When graphInteractive is true, the budget value is ignored.
The response carries graph.metadata.interactive: true so a stored result is self-describing, and graph.metadata.stoppedReason reads max_depth_reached.
Continuing from a previous request
To extend a graph from one or morebudget_truncated placeholders, pass their nodeIds in graphContinueFromNodeIds and link to the parent through mainRequestId. countryCode and id are derived from the parent automatically.
graphInteractive: true, every continuation inherits the flag. The seeded node is fetched and its own direct shareholders are surfaced as a fresh layer of placeholders, ready for the next click.
Best Practices
Pick the right control: budget vs. interactive
Pick the right control: budget vs. interactive
Use
graphMaxBudget when you want a single response with as much of the tree as fits within a known cost ceiling. Use graphInteractive when you want predictable per-step cost and a deterministic UI: one fetch per request, the rest of the tree visible only as continuation handles you choose to expand.Set an appropriate budget
Set an appropriate budget
The
graphMaxBudget parameter is the primary way to control non-interactive traversal scope. Start with a lower budget for exploration, then increase if you need deeper coverage. Each company lookup costs the standard price for that country.Expect variable execution times
Expect variable execution times
Graph traversal time depends on the number of companies, the countries involved, and registry response times. Simple structures (1-2 levels, single country) complete in seconds. Complex multi-country structures with deep chains can take several minutes. Interactive requests are bounded by a single company fetch, so they return as fast as that country’s registry replies.
Handle partial results
Handle partial results
When a limit is reached, the graph returns everything collected so far. Check
metadata.stoppedReason to understand why traversal stopped and whether requesting again with a higher budget, or extending via graphContinueFromNodeIds, would yield more data.