Skip to content

fix: align GraphQL docs with live schema #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonathanprozzi merged 5 commits into from
Apr 1, 2026
Merged

fix: align GraphQL docs with live schema #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
62c7b9a
fix: correct ghost fields and stale queries in GraphQL overview docs
jonathanprozzi Apr 1, 2026
f39d327
fix: correct response field types to match live schema
jonathanprozzi Apr 1, 2026
74e6363
fix: add missing schema fields to response tables
jonathanprozzi Apr 1, 2026
1d4fd20
fix: use real Intuition atom in single-atom example query
jonathanprozzi Apr 1, 2026
9316de0
fix: replace placeholder IDs with real on-chain data in query examples
jonathanprozzi Apr 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/_data/graphql-api/queries/accounts/following.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ query GetFollowing(

```json
{
"account_id": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045",
"account_id": "0x88D0aF73508452c1a453356b3Fac26525aEc23A2",
"limit": 20,
"offset": 0
}
Expand Down Expand Up @@ -104,7 +104,7 @@ export const followingQueries = [
}
}`,
variables: {
account_id: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045',
account_id: '0x88D0aF73508452c1a453356b3Fac26525aEc23A2',
limit: 10
}
},
Expand All @@ -127,7 +127,7 @@ export const followingQueries = [
}
}`,
variables: {
account_id: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045',
account_id: '0x88D0aF73508452c1a453356b3Fac26525aEc23A2',
limit: 10
}
},
Expand All @@ -149,7 +149,7 @@ export const followingQueries = [
}
}`,
variables: {
account_a: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045',
account_a: '0x88D0aF73508452c1a453356b3Fac26525aEc23A2',
account_b: '0xabc...'
}
}
Expand Down
3 changes: 1 addition & 2 deletions docs/_data/graphql-api/queries/accounts/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,12 @@ const query = `
image
type
atom_id
created_at
}
}
`

const data = await client.request(query, {
id: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
id: '0x88D0aF73508452c1a453356b3Fac26525aEc23A2'
})
```

Expand Down
6 changes: 3 additions & 3 deletions docs/_data/graphql-api/queries/accounts/positions-from-following.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ query GetPositionsFromFollowing(

```json
{
"account_id": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045",
"account_id": "0x88D0aF73508452c1a453356b3Fac26525aEc23A2",
"limit": 20,
"offset": 0
}
Expand Down Expand Up @@ -130,7 +130,7 @@ export const positionsQueries = [
}
}`,
variables: {
account_id: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045',
account_id: '0x88D0aF73508452c1a453356b3Fac26525aEc23A2',
limit: 10
}
},
Expand Down Expand Up @@ -159,7 +159,7 @@ export const positionsQueries = [
}
}`,
variables: {
account_id: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
account_id: '0x88D0aF73508452c1a453356b3Fac26525aEc23A2'
}
}
];
Expand Down
16 changes: 8 additions & 8 deletions docs/_data/graphql-api/queries/accounts/single-account.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ query GetAccount($id: String!) {

```json
{
"id": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045"
"id": "0x88D0aF73508452c1a453356b3Fac26525aEc23A2"
}
```

Expand All @@ -46,23 +46,23 @@ query GetAccount($id: String!) {
| `id` | `String` | Account address (primary key) |
| `label` | `String` | Human-readable name (from atom or ENS) |
| `image` | `String` | Profile image URL |
| `type` | `String` | Account type: `Default`, `AtomWallet`, `ProtocolVault` |
| `type` | `account_type` | Account type: `Default`, `AtomWallet`, `ProtocolVault` |
| `atom_id` | `String` | Linked atom ID (if any) |
| `atom` | `Atom` | Linked atom details |
| `atom` | `atoms` | Linked atom details |

## Expected Response

```json
{
"data": {
"account": {
"id": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045",
"id": "0x88D0aF73508452c1a453356b3Fac26525aEc23A2",
"label": "vitalik.eth",
"image": "ipfs://QmXnnyufdzAWL5CqZ2RnSNgPbvCc1ALT73s6epPrRnZ1Xy",
"type": "AtomWallet",
"atom_id": "0x57d94c116a33bb460428eced262b7ae2ec6f865e7aceef6357cec3d034e8ea21",
"atom_id": "0x906527aae4af914b1ac01ff9adfdda5dafde3b5e21f84045e0660b0a15c07769",
"atom": {
"term_id": "0x57d94c116a33bb460428eced262b7ae2ec6f865e7aceef6357cec3d034e8ea21",
"term_id": "0x906527aae4af914b1ac01ff9adfdda5dafde3b5e21f84045e0660b0a15c07769",
"data": "ipfs://Qm...",
"type": "Person"
}
Expand All @@ -86,7 +86,7 @@ export const accountQueries = [
}
}`,
variables: {
id: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
id: '0x88D0aF73508452c1a453356b3Fac26525aEc23A2'
}
},
{
Expand All @@ -107,7 +107,7 @@ export const accountQueries = [
}
}`,
variables: {
id: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
id: '0x88D0aF73508452c1a453356b3Fac26525aEc23A2'
}
}
];
Expand Down
4 changes: 2 additions & 2 deletions docs/_data/graphql-api/queries/advanced/time-series.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ export const timeSeriesQueries = [
}
}`,
variables: {
termId: '0x57d94c116a33bb460428eced262b7ae2ec6f865e7aceef6357cec3d034e8ea21',
termId: '0x906527aae4af914b1ac01ff9adfdda5dafde3b5e21f84045e0660b0a15c07769',
curveId: '1',
limit: 30
}
Expand All @@ -219,7 +219,7 @@ export const timeSeriesQueries = [
}
}`,
variables: {
termId: '0x57d94c116a33bb460428eced262b7ae2ec6f865e7aceef6357cec3d034e8ea21',
termId: '0x906527aae4af914b1ac01ff9adfdda5dafde3b5e21f84045e0660b0a15c07769',
curveId: '1',
limit: 30
}
Expand Down
2 changes: 1 addition & 1 deletion docs/_data/graphql-api/queries/atoms/list-filter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ export const listFilterQueries = [
}
}`,
variables: {
creatorId: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045',
creatorId: '0x88D0aF73508452c1a453356b3Fac26525aEc23A2',
limit: 20
}
},
Expand Down
24 changes: 12 additions & 12 deletions docs/_data/graphql-api/queries/atoms/single-atom.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ query GetAtom($id: String!) {

```json
{
"id": "0x57d94c116a33bb460428eced262b7ae2ec6f865e7aceef6357cec3d034e8ea21"
"id": "0x39ad516aba15924381204ce477cf4d2b5313200814691e5376961673866ba4e3"
}
```

Expand All @@ -47,17 +47,17 @@ query GetAtom($id: String!) {
{
"data": {
"atom": {
"term_id": "0x57d94c116a33bb460428eced262b7ae2ec6f865e7aceef6357cec3d034e8ea21",
"data": "ipfs://QmYx8C3kNN1sFSx5b...",
"label": "Ethereum",
"image": "ipfs://QmXnnyufdzAWL5CqZ2RnSNgPbvCc1ALT73s6epPrRnZ1Xy",
"emoji": "⟠",
"term_id": "0x39ad516aba15924381204ce477cf4d2b5313200814691e5376961673866ba4e3",
"data": "https://res.cloudinary.com/...",
"label": "Intuition",
"image": "https://res.cloudinary.com/dfpwy9nyv/image/upload/v1734057836/remix/l7ffhwwrbrrgrnqclvs1.png",
"emoji": "🧩",
"type": "Thing",
"created_at": "2024-01-15T10:30:00Z",
"created_at": "2025-11-01T05:19:50+00:00",
"creator": {
"id": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045",
"label": "Alice",
"image": "ipfs://..."
"id": "0x774657D5fFb9d169D65ac5dCeEdD0f566d9E7853",
"label": "0x7746...7853",
"image": null
}
}
}
Expand Down Expand Up @@ -87,7 +87,7 @@ export const singleAtomQueries = [
}
}`,
variables: {
id: '0x57d94c116a33bb460428eced262b7ae2ec6f865e7aceef6357cec3d034e8ea21'
id: '0x39ad516aba15924381204ce477cf4d2b5313200814691e5376961673866ba4e3'
}
},
{
Expand All @@ -114,7 +114,7 @@ export const singleAtomQueries = [
}
}`,
variables: {
id: '0x57d94c116a33bb460428eced262b7ae2ec6f865e7aceef6357cec3d034e8ea21'
id: '0x39ad516aba15924381204ce477cf4d2b5313200814691e5376961673866ba4e3'
}
}
];
Expand Down
4 changes: 2 additions & 2 deletions docs/_data/graphql-api/queries/atoms/with-triples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ export const tripleQueries = [
}
}`,
variables: {
atomId: '0xf12dba36ffebb8e05ae49d3f9220b1994295662ccdc573f44aff7b51f8ad8fd6',
atomId: '0x906527aae4af914b1ac01ff9adfdda5dafde3b5e21f84045e0660b0a15c07769',
limit: 10
}
},
Expand All @@ -83,7 +83,7 @@ export const tripleQueries = [
}
}`,
variables: {
atomId: '0xf12dba36ffebb8e05ae49d3f9220b1994295662ccdc573f44aff7b51f8ad8fd6',
atomId: '0x906527aae4af914b1ac01ff9adfdda5dafde3b5e21f84045e0660b0a15c07769',
predicateId: '0x...',
limit: 10
}
Expand Down
6 changes: 3 additions & 3 deletions docs/_data/graphql-api/queries/atoms/with-vault.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ query GetAtomWithVault($atomId: String!, $curveId: numeric!) {

```json
{
"atomId": "0x57d94c116a33bb460428eced262b7ae2ec6f865e7aceef6357cec3d034e8ea21",
"atomId": "0x906527aae4af914b1ac01ff9adfdda5dafde3b5e21f84045e0660b0a15c07769",
"curveId": "1"
}
```
Expand All @@ -71,7 +71,7 @@ export const vaultQueries = [
}
}`,
variables: {
atomId: '0x57d94c116a33bb460428eced262b7ae2ec6f865e7aceef6357cec3d034e8ea21',
atomId: '0x906527aae4af914b1ac01ff9adfdda5dafde3b5e21f84045e0660b0a15c07769',
curveId: '1'
}
},
Expand Down Expand Up @@ -99,7 +99,7 @@ export const vaultQueries = [
}
}`,
variables: {
atomId: '0x57d94c116a33bb460428eced262b7ae2ec6f865e7aceef6357cec3d034e8ea21',
atomId: '0x906527aae4af914b1ac01ff9adfdda5dafde3b5e21f84045e0660b0a15c07769',
curveId: '1'
}
}
Expand Down
4 changes: 2 additions & 2 deletions docs/_data/graphql-api/queries/charts/chart-json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The query takes a single `input` object of type `GetChartJsonInput`:
```json
{
"input": {
"term_id": "0x57d94c116a33bb460428eced262b7ae2ec6f865e7aceef6357cec3d034e8ea21",
"term_id": "0x906527aae4af914b1ac01ff9adfdda5dafde3b5e21f84045e0660b0a15c07769",
"curve_id": "1",
"interval": "1d",
"start_time": "2024-01-01T00:00:00Z",
Expand Down Expand Up @@ -89,7 +89,7 @@ export const chartJsonQueries = [
}`,
variables: {
input: {
term_id: '0x57d94c116a33bb460428eced262b7ae2ec6f865e7aceef6357cec3d034e8ea21',
term_id: '0x906527aae4af914b1ac01ff9adfdda5dafde3b5e21f84045e0660b0a15c07769',
curve_id: '1',
interval: '1d',
start_time: '2024-01-01T00:00:00Z',
Expand Down
2 changes: 1 addition & 1 deletion docs/_data/graphql-api/queries/charts/chart-raw-json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Same as [`getChartJson`](./chart-json) -- takes `GetChartJsonInput`:
```json
{
"input": {
"term_id": "0x57d94c116a33bb460428eced262b7ae2ec6f865e7aceef6357cec3d034e8ea21",
"term_id": "0x906527aae4af914b1ac01ff9adfdda5dafde3b5e21f84045e0660b0a15c07769",
"curve_id": "1",
"interval": "1d",
"start_time": "2024-01-01T00:00:00Z",
Expand Down
2 changes: 1 addition & 1 deletion docs/_data/graphql-api/queries/charts/chart-raw-svg.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Same as [`getChartSvg`](./chart-svg) -- takes `GetChartSvgInput`:
```json
{
"input": {
"term_id": "0x57d94c116a33bb460428eced262b7ae2ec6f865e7aceef6357cec3d034e8ea21",
"term_id": "0x906527aae4af914b1ac01ff9adfdda5dafde3b5e21f84045e0660b0a15c07769",
"curve_id": "1",
"interval": "1d",
"start_time": "2024-01-01T00:00:00Z",
Expand Down
4 changes: 2 additions & 2 deletions docs/_data/graphql-api/queries/charts/chart-svg.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The query takes a single `input` object of type `GetChartSvgInput`:
```json
{
"input": {
"term_id": "0x57d94c116a33bb460428eced262b7ae2ec6f865e7aceef6357cec3d034e8ea21",
"term_id": "0x906527aae4af914b1ac01ff9adfdda5dafde3b5e21f84045e0660b0a15c07769",
"curve_id": "1",
"interval": "1d",
"start_time": "2024-01-01T00:00:00Z",
Expand Down Expand Up @@ -84,7 +84,7 @@ export const chartSvgQueries = [
}`,
variables: {
input: {
term_id: '0x57d94c116a33bb460428eced262b7ae2ec6f865e7aceef6357cec3d034e8ea21',
term_id: '0x906527aae4af914b1ac01ff9adfdda5dafde3b5e21f84045e0660b0a15c07769',
curve_id: '1',
interval: '1d',
start_time: '2024-01-01T00:00:00Z',
Expand Down
4 changes: 2 additions & 2 deletions docs/_data/graphql-api/queries/events/list-events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ query GetEvents(
| Field | Type | Description |
|-------|------|-------------|
| `id` | `String` | Unique event identifier |
| `type` | `String` | Event type |
| `block_number` | `Int` | Block number |
| `type` | `event_type` | Event type (enum) |
| `block_number` | `numeric` | Block number |
| `created_at` | `timestamptz` | Event timestamp |
| `transaction_hash` | `String` | Transaction hash |
| `atom_id` | `String` | Related atom ID (if applicable) |
Expand Down
8 changes: 4 additions & 4 deletions docs/_data/graphql-api/queries/leaderboard/account-rank.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Look up a single account's leaderboard rank and percentile using `get_account_pn
query GetAccountPnlRank {
get_account_pnl_rank(
args: {
p_account_id: "0xd8da6bf26964af9d7eed9e03e53415d37aa96045"
p_account_id: "0x88D0aF73508452c1a453356b3Fac26525aEc23A2"
p_sort_by: "total_pnl"
}
) {
Expand Down Expand Up @@ -55,10 +55,10 @@ query GetAccountPnlRank {
| `account_image` | `String` | Profile image URL |
| `rank` | `bigint` | Leaderboard rank position |
| `percentile` | `numeric` | Percentile ranking (0-100) |
| `total_pnl_formatted` | `String` | Total profit/loss (formatted) |
| `total_pnl_formatted` | `numeric` | Total profit/loss (formatted) |
| `total_pnl_raw` | `numeric` | Total profit/loss (raw) |
| `pnl_pct` | `numeric` | PnL percentage |
| `total_volume_formatted` | `String` | Total trading volume (formatted) |
| `total_volume_formatted` | `numeric` | Total trading volume (formatted) |
| `total_volume_raw` | `numeric` | Total trading volume (raw) |
| `total_position_count` | `bigint` | Total number of positions |
| `win_rate` | `numeric` | Win rate across positions |
Expand All @@ -73,7 +73,7 @@ export const rankQueries = [
query: `query GetAccountPnlRank {
get_account_pnl_rank(
args: {
p_account_id: "0xd8da6bf26964af9d7eed9e03e53415d37aa96045"
p_account_id: "0x88D0aF73508452c1a453356b3Fac26525aEc23A2"
p_sort_by: "total_pnl"
}
) {
Expand Down
10 changes: 5 additions & 5 deletions docs/_data/graphql-api/queries/leaderboard/leaderboard-stats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,15 @@ query GetPnlLeaderboardStats {
| `profitable_traders` | `bigint` | Number of traders with positive PnL |
| `unprofitable_traders` | `bigint` | Number of traders with negative PnL |
| `profitable_pct` | `numeric` | Percentage of profitable traders |
| `total_pnl_sum_formatted` | `String` | Sum of all PnL across traders (formatted) |
| `total_pnl_sum_formatted` | `numeric` | Sum of all PnL across traders (formatted) |
| `total_pnl_sum_raw` | `numeric` | Sum of all PnL across traders (raw) |
| `avg_pnl_formatted` | `String` | Average PnL per trader (formatted) |
| `avg_pnl_formatted` | `numeric` | Average PnL per trader (formatted) |
| `avg_pnl_raw` | `numeric` | Average PnL per trader (raw) |
| `median_pnl_formatted` | `String` | Median PnL across traders (formatted) |
| `median_pnl_formatted` | `numeric` | Median PnL across traders (formatted) |
| `median_pnl_raw` | `numeric` | Median PnL across traders (raw) |
| `total_volume_formatted` | `String` | Total trading volume across all traders (formatted) |
| `total_volume_formatted` | `numeric` | Total trading volume across all traders (formatted) |
| `total_volume_raw` | `numeric` | Total trading volume across all traders (raw) |
| `avg_volume_formatted` | `String` | Average volume per trader (formatted) |
| `avg_volume_formatted` | `numeric` | Average volume per trader (formatted) |
| `avg_volume_raw` | `numeric` | Average volume per trader (raw) |

## Interactive Example
Expand Down
2 changes: 1 addition & 1 deletion docs/_data/graphql-api/queries/leaderboard/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The Intuition GraphQL API provides leaderboard queries for ranking accounts and
| Operation | Description |
|-----------|-------------|
| [`get_vault_leaderboard`](./vault-leaderboard) | Vault-level leaderboard filtered by term and curve |
| [`get_vault_leaderboard_period`](./vault-leaderboard#period-scoped) | Period-scoped vault leaderboard with date range |
| [`get_pnl_leaderboard_period`](./vault-leaderboard#period-scoped) | Period-scoped leaderboard with date range (use `p_term_id`/`p_curve_id` for vault scoping) |

### Account Rank & Stats

Expand Down
2 changes: 2 additions & 0 deletions docs/_data/graphql-api/queries/leaderboard/pnl-leaderboard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,10 @@ query GetPnlLeaderboard {
| `total_pnl_raw` | `numeric` | Total PnL (raw wei) |
| `unrealized_pnl_formatted` | `numeric` | Unrealized PnL (formatted) |
| `unrealized_pnl_raw` | `numeric` | Unrealized PnL (raw) |
| `unrealized_pnl_pct` | `numeric` | Unrealized PnL percentage |
| `realized_pnl_formatted` | `numeric` | Realized PnL (formatted) |
| `realized_pnl_raw` | `numeric` | Realized PnL (raw) |
| `realized_pnl_pct` | `numeric` | Realized PnL percentage |
| `pnl_change_formatted` | `numeric` | PnL change (formatted) |
| `pnl_change_raw` | `numeric` | PnL change (raw) |

Expand Down
Loading
Loading