# 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 `) *** | 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](/docs/develop/guardian/global-indexer/indexer-apis/full-text-indexer-search.md) * [Returns DIDs](/docs/develop/guardian/global-indexer/indexer-apis/returns-dids.md) * [Returns DID as per Message ID](/docs/develop/guardian/global-indexer/indexer-apis/returns-did-as-per-messageid.md) * [Returns DID Relationships](/docs/develop/guardian/global-indexer/indexer-apis/returns-did-relationships.md) * [Returns VC Documents](/docs/develop/guardian/global-indexer/indexer-apis/returns-vc-documents.md) * [Returns VC Document as per Message ID](/docs/develop/guardian/global-indexer/indexer-apis/returns-vc-document-as-per-messageid.md) * [Returns VC Relationships](/docs/develop/guardian/global-indexer/indexer-apis/returns-vc-relationships.md) * [Returns VP Documents](/docs/develop/guardian/global-indexer/indexer-apis/returns-vp-documents.md) * [Returns VP Document as per Message ID](/docs/develop/guardian/global-indexer/indexer-apis/returns-vp-document-as-per-messageid.md) * [Returns VP Relationships](/docs/develop/guardian/global-indexer/indexer-apis/returns-vp-relationships.md) * [Returns Policies](/docs/develop/guardian/global-indexer/indexer-apis/returns-policies.md) * [Returns Policy as per Message ID](/docs/develop/guardian/global-indexer/indexer-apis/returns-policy-as-per-messageid.md) * [Returns Policy Relationships](/docs/develop/guardian/global-indexer/indexer-apis/returns-policy-relationships.md) * [Returns Schemas](/docs/develop/guardian/global-indexer/indexer-apis/returns-schemas.md) * [Returns Schema as per Message ID](/docs/develop/guardian/global-indexer/indexer-apis/returns-schema-as-per-messageid.md) * [Returns Schema Tree](/docs/develop/guardian/global-indexer/indexer-apis/returns-schema-tree.md) * [Returns Tokens](/docs/develop/guardian/global-indexer/indexer-apis/returns-tokens.md) * [Returns Token as per Token ID](/docs/develop/guardian/global-indexer/indexer-apis/returns-token-as-per-tokenid.md) * [Returns NFTs](/docs/develop/guardian/global-indexer/indexer-apis/returns-nfts.md) * [Returns NFT as per Serial No.](/docs/develop/guardian/global-indexer/indexer-apis/returns-nft-as-per-serial-no..md) * [Returns Topics](/docs/develop/guardian/global-indexer/indexer-apis/returns-topics.md) * [Returns Topic as per Topic ID](/docs/develop/guardian/global-indexer/indexer-apis/returns-topic-as-per-topicid.md) * [Returns Contracts](/docs/develop/guardian/global-indexer/indexer-apis/returns-contracts.md) * [Returns Contract as per Message ID](/docs/develop/guardian/global-indexer/indexer-apis/returns-contract-as-per-messageid.md) * [Returns Modules](/docs/develop/guardian/global-indexer/indexer-apis/returns-modules.md) * [Returns Module as per Message ID](/docs/develop/guardian/global-indexer/indexer-apis/returns-module-as-per-messageid.md) * [Returns Tools](/docs/develop/guardian/global-indexer/indexer-apis/returns-tools.md) * [Returns Tool as per Message ID](/docs/develop/guardian/global-indexer/indexer-apis/returns-tool-as-per-messageid.md) * [Returns Roles](/docs/develop/guardian/global-indexer/indexer-apis/returns-roles.md) * [Returns Role as per Message ID](/docs/develop/guardian/global-indexer/indexer-apis/returns-role-as-per-messageid.md) * [Returns Standard Registries](/docs/develop/guardian/global-indexer/indexer-apis/returns-standard-registries.md) * [Returns Registry as per Message ID](/docs/develop/guardian/global-indexer/indexer-apis/returns-registry-as-per-messageid.md) * [Returns Registry Relationships](/docs/develop/guardian/global-indexer/indexer-apis/returns-registry-relationships.md) * [Returns Registry Users](/docs/develop/guardian/global-indexer/indexer-apis/returns-registry-users.md) * [Returns Registry User as per Message ID](/docs/develop/guardian/global-indexer/indexer-apis/returns-registry-user-as-per-messageid.md) * [Retrieve the List of Formulas](/docs/develop/guardian/global-indexer/indexer-apis/retrieve-the-list-of-formulas.md) * [Retrieve the Formula by Message ID](/docs/develop/guardian/global-indexer/indexer-apis/retrieve-the-formula-by-message-id.md) * [Retrieve Linked Documents Related to Formula](/docs/develop/guardian/global-indexer/indexer-apis/retrieve-linked-documents-which-are-related-to-formula.md) * [Returns Search Policy Results](/docs/develop/guardian/global-indexer/indexer-apis/returns-search-policy-results.md) * [Comparing the Policy Changes as per ID](/docs/develop/guardian/global-indexer/indexer-apis/comparing-the-policy-changes-as-per-id.md) * [Display the Derivations](/docs/develop/guardian/global-indexer/indexer-apis/display-the-derivations.md) * [Returns Landing Page Analytics](/docs/develop/guardian/global-indexer/indexer-apis/returns-landing-page-analytics.md) * [Returns Hedera Network Explorer Settings](/docs/develop/guardian/global-indexer/indexer-apis/returns-hedera-network-explorer-settings.md) * [Returns Hedera Network](/docs/develop/guardian/global-indexer/indexer-apis/returns-hedera-network.md) * [Returns Project Coordinates](/docs/develop/guardian/global-indexer/indexer-apis/returns-project-coordinates.md) * [Adding Policy Data for Priority Loading](/docs/develop/guardian/global-indexer/indexer-apis/adding-policy-data-for-priority-loading.md) * [Adding Token Data for Priority Loading](/docs/develop/guardian/global-indexer/indexer-apis/adding-token-data-for-priority-loading.md) * [Adding Topic Data Priority Loading](/docs/develop/guardian/global-indexer/indexer-apis/adding-topic-data-priority-loading.md) * [Adding Document to Data Priority Loading](/docs/develop/guardian/global-indexer/indexer-apis/adding-document-to-data-priority-loading.md) * [Returning Topic Data Priority Loading Progress](/docs/develop/guardian/global-indexer/indexer-apis/returning-topic-data-priority-loading-progress.md) * [Returns Data Loading Progress Result](/docs/develop/guardian/global-indexer/indexer-apis/returns-data-loading-progress-result.md) * [Attempts to Refresh Linked Files for the Selected Documents](/docs/develop/guardian/global-indexer/indexer-apis/attempts-to-refresh-linked-files-for-the-selected-documents.md) * [Download File by ID](/docs/develop/guardian/global-indexer/indexer-apis/download-file-by-id.md) * [Removes a File from IPFS by CID](/docs/develop/guardian/global-indexer/indexer-apis/removes-a-file-from-ipfs-by-cid.md) --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://guardian.hedera.com/docs/develop/guardian/global-indexer/indexer-apis.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.