Indexer APIs

Endpoints for the Guardian Global Indexer service, which provides search and analytics across all Hedera-based Guardian entities including policies, schemas, tokens, DIDs, VCs, VPs, and more.

Authentication: Bearer token required for most endpoints (Authorization: Bearer <token>)

---

Method	Endpoint	Description	Auth Required
GET	/api/v1/search	Full-text search across all indexed entities	Yes
GET	/api/v1/entities/did-documents	Returns all indexed DID documents	Yes
GET	/api/v1/entities/did-documents/{messageId}	Returns a DID document by message ID	Yes
GET	/api/v1/entities/did-documents/{messageId}/relationships	Returns DID relationships	Yes
GET	/api/v1/entities/vc-documents	Returns all indexed VC documents	Yes
GET	/api/v1/entities/vc-documents/{messageId}	Returns a VC document by message ID	Yes
GET	/api/v1/entities/vc-documents/{messageId}/relationships	Returns VC document relationships	Yes
GET	/api/v1/entities/vp-documents	Returns all indexed VP documents	Yes
GET	/api/v1/entities/vp-documents/{messageId}	Returns a VP document by message ID	Yes
GET	/api/v1/entities/vp-documents/{messageId}/relationships	Returns VP document relationships	Yes
GET	/api/v1/entities/policies	Returns all indexed policies	Yes
GET	/api/v1/entities/policies/{messageId}	Returns a policy by message ID	Yes
GET	/api/v1/entities/policies/{messageId}/relationships	Returns policy relationships	Yes
GET	/api/v1/entities/schemas	Returns all indexed schemas	Yes
GET	/api/v1/entities/schemas/{messageId}	Returns a schema by message ID	Yes
GET	/api/v1/entities/schemas/{messageId}/tree	Returns the schema tree	Yes
GET	/api/v1/entities/tokens	Returns all indexed tokens	Yes
GET	/api/v1/entities/tokens/{tokenId}	Returns a token by token ID	Yes
GET	/api/v1/entities/nfts	Returns all indexed NFTs	Yes
GET	/api/v1/entities/nfts/{serialNumber}	Returns an NFT by serial number	Yes
GET	/api/v1/entities/topics	Returns all indexed Hedera topics	Yes
GET	/api/v1/entities/topics/{topicId}	Returns a topic by topic ID	Yes
GET	/api/v1/entities/contracts	Returns all indexed retirement contracts	Yes
GET	/api/v1/entities/contracts/{messageId}	Returns a contract by message ID	Yes
GET	/api/v1/entities/modules	Returns all indexed modules	Yes
GET	/api/v1/entities/modules/{messageId}	Returns a module by message ID	Yes
GET	/api/v1/entities/tools	Returns all indexed tools	Yes
GET	/api/v1/entities/tools/{messageId}	Returns a tool by message ID	Yes
GET	/api/v1/entities/roles	Returns all indexed roles	Yes
GET	/api/v1/entities/roles/{messageId}	Returns a role by message ID	Yes
GET	/api/v1/entities/standard-registries	Returns all indexed Standard Registry accounts	Yes
GET	/api/v1/entities/standard-registries/{messageId}	Returns a Standard Registry by message ID	Yes
GET	/api/v1/entities/standard-registries/{messageId}/relationships	Returns Standard Registry relationships	Yes
GET	/api/v1/entities/registry-users	Returns all indexed registry users	Yes
GET	/api/v1/entities/registry-users/{messageId}	Returns a registry user by message ID	Yes
GET	/api/v1/entities/formulas	Returns all indexed formulas	Yes
GET	/api/v1/entities/formulas/{messageId}	Returns a formula by message ID	Yes
GET	/api/v1/entities/formulas/{messageId}/relationships	Returns formula relationships	Yes
GET	/api/v1/analytics/search/policies	Returns search results for policies	Yes
GET	/api/v1/analytics/compare/policy/original/{messageId}	Compares policy changes by message ID	Yes
GET	/api/v1/analytics/derivations/{messageId}	Returns policy derivations	Yes
GET	/api/v1/landing	Returns landing page analytics	No
GET	/api/v1/landing/settings	Returns Hedera network explorer settings	No
GET	/api/v1/landing/network	Returns the Hedera network name	No
GET	/api/v1/landing/coordinates	Returns project geo-coordinates	No
POST	/api/v1/landing/data-priority-policy	Adds policy data to the priority loading queue	Yes
POST	/api/v1/landing/data-priority-tokens	Adds token data to the priority loading queue	Yes
POST	/api/v1/landing/data-priority-topics	Adds topic data to the priority loading queue	Yes
POST	/api/v1/landing/data-priority-any/{entityId}	Adds any entity to the priority loading queue	Yes
GET	/api/v1/landing/progress	Returns data loading progress	Yes
POST	/api/v1/entities/update-files	Refreshes linked files for the selected documents	Yes
GET	/api/v1/artifacts/files/{fileId}	Downloads a file by ID	Yes
DELETE	/api/v1/ipfs/file/{cid}	Removes a file from IPFS by CID	Yes

Endpoints

• Full-Text Indexer Search

• Returns DIDs

• Returns DID as per Message ID

• Returns DID Relationships

• Returns VC Documents

• Returns VC Document as per Message ID

• Returns VC Relationships

• Returns VP Documents

• Returns VP Document as per Message ID

• Returns VP Relationships

• Returns Policies

• Returns Policy as per Message ID

• Returns Policy Relationships

• Returns Schemas

• Returns Schema as per Message ID

• Returns Schema Tree

• Returns Tokens

• Returns Token as per Token ID

• Returns NFTs

• Returns NFT as per Serial No.

• Returns Topics

• Returns Topic as per Topic ID

• Returns Contracts

• Returns Contract as per Message ID

• Returns Modules

• Returns Module as per Message ID

• Returns Tools

• Returns Tool as per Message ID

• Returns Roles

• Returns Role as per Message ID

• Returns Standard Registries

• Returns Registry as per Message ID

• Returns Registry Relationships

• Returns Registry Users

• Returns Registry User as per Message ID

• Retrieve the List of Formulas

• Retrieve the Formula by Message ID

• Retrieve Linked Documents Related to Formula

• Returns Search Policy Results

• Comparing the Policy Changes as per ID

• Display the Derivations

• Returns Landing Page Analytics

• Returns Hedera Network Explorer Settings

• Returns Hedera Network

• Returns Project Coordinates

• Adding Policy Data for Priority Loading

• Adding Token Data for Priority Loading

• Adding Topic Data Priority Loading

• Adding Document to Data Priority Loading

• Returning Topic Data Priority Loading Progress

• Returns Data Loading Progress Result

• Attempts to Refresh Linked Files for the Selected Documents

• Download File by ID

• Removes a File from IPFS by CID