Skip to content

Fix Scan API 404 and consolidate endpoint navigation #709

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

Draft
8bitpal wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Fix Scan API 404 and consolidate endpoint navigation #709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
55349d9
Fix Scan API 404 and consolidate nav (issue #698)
8bitpal Jun 9, 2026
e08991e
Merge branch 'main' into issue-698-scan-api-single-page
8bitpal Jun 9, 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
2 changes: 1 addition & 1 deletion docs-main/api-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The API Reference covers every programmatic interface to Canton - review endpoin
</Card>

<Card title="Splice APIs" icon="bookmark" href="/reference/splice-scan-api/common/readyz">
Developing with Canton Network's OpenAPI endpoints for: Canton Coin data, name service, token standard, and more.
OpenAPI endpoints for Canton Coin data, name service, token standard, and more — including the Scan, Wallet, ANS, and Token Standard APIs.
</Card>
</Columns>

Expand Down
75 changes: 1 addition & 74 deletions docs-main/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1780,80 +1780,7 @@
"openapi": {
"source": "openapi/splice/scan/scan.yaml",
"directory": "reference/splice-scan-api"
},
"pages": [
"GET /readyz",
"GET /livez",
"GET /status",
"GET /version",
"GET /v0/dso",
"GET /v0/validators/validator-faucets",
"GET /v0/scans",
"GET /v0/admin/validator/licenses",
"GET /v0/dso-sequencers",
"GET /v0/sv-bft-sequencers",
"GET /v0/domains/{domain_id}/parties/{party_id}/participant-id",
"GET /v1/domains/{domain_id}/parties/{party_id}/participant-id",
"GET /v0/domains/{domain_id}/members/{member_id}/traffic-status",
"GET /v0/closed-rounds",
"POST /v0/open-and-issuing-mining-rounds",
"POST /v2/updates",
"GET /v2/updates/{update_id}",
"POST /v1/updates",
"GET /v1/updates/{update_id}",
"GET /v0/state/acs/snapshot-timestamp",
"GET /v0/state/acs/snapshot-timestamp-after",
"POST /v0/state/acs",
"POST /v0/state/acs/force",
"POST /v0/holdings/state",
"POST /v0/holdings/summary",
"GET /v0/ans-entries",
"GET /v0/ans-entries/by-party/{party}",
"GET /v0/ans-entries/by-name/{name}",
"GET /v0/dso-party-id",
"POST /v0/amulet-rules",
"POST /v0/external-party-amulet-rules",
"POST /v0/ans-rules",
"GET /v0/featured-apps",
"GET /v0/featured-apps/{provider_party_id}",
"GET /v0/top-validators-by-validator-faucets",
"GET /v0/transfer-preapprovals/by-party/{party}",
"GET /v0/transfer-command-counter/{party}",
"GET /v0/transfer-command/status",
"GET /v0/migrations/schedule",
"GET /v0/synchronizer-identities/{domain_id_prefix}",
"GET /v0/synchronizer-bootstrapping-transactions/{domain_id_prefix}",
"GET /v0/splice-instance-names",
"GET /v0/amulet-price/votes",
"POST /v0/voterequest",
"GET /v0/voterequests/{vote_request_contract_id}",
"GET /v0/admin/sv/voterequests",
"POST /v0/admin/sv/voteresults",
"POST /v0/backfilling/migration-info",
"POST /v0/backfilling/updates-before",
"GET /v0/backfilling/status",
"GET /v0/acs/{party}",
"GET /v0/aggregated-rounds",
"POST /v0/round-totals",
"POST /v0/round-party-totals",
"GET /v0/amulet-config-for-round",
"GET /v0/round-of-latest-data",
"GET /v0/rewards-collected",
"GET /v0/top-providers-by-app-rewards",
"GET /v0/top-validators-by-validator-rewards",
"GET /v0/top-validators-by-purchased-traffic",
"POST /v0/activities",
"POST /v0/transactions",
"POST /v0/updates",
"GET /v0/updates/{update_id}",
"GET /v0/feature-support",
"POST /v0/backfilling/import-updates",
"POST /v0/events",
"GET /v0/events/{update_id}",
"GET /v0/unclaimed-development-fund-coupons",
"GET /v0/history/bulk/acs",
"POST /v0/history/bulk/updates"
]
}
},
{
"group": "Scan Streaming API",
Expand Down
3 changes: 3 additions & 0 deletions docs-main/openapi/splice/scan/scan.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ info:
servers:
- url: https://scan.sv-1.global.canton.network.sync.global/api/scan
tags:
- name: common
description: |
Health and status endpoints available on all nodes.
- name: external
description: |
These endpoints are intended for public usage and will remain backward-compatible.
Expand Down
2 changes: 1 addition & 1 deletion docs-main/sdks-tools/api-reference/splice-scan-openapi.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Scan Open API Reference"
description: "Full OpenAPI specification for the Scan API"
---

The complete OpenAPI specification for the Scan API is published as a generated reference under [Scan API](/reference/splice-scan-api/common/readyz). It is organized by tag and includes the request and response schemas for every endpoint.
The complete OpenAPI specification for the Scan API is published as a generated reference under [Scan API](/reference/splice-scan-api/common/readyz). It is organized by tag (common, external, internal, deprecated, pre-alpha) and includes the request and response schemas for every endpoint.

For an overview of the individual Scan API surfaces (current state, bulk data, aggregates, connectivity, operations, and CC reference data), see [Scan APIs](/sdks-tools/api-reference/splice-scan-api).

Expand Down