Murmurations Index API

Index API Documentation 📙

https://app.swaggerhub.com/apis-docs/MurmurationsNetwork/IndexAPI/2.0.0

The Index API enables nodes, using predefined schemas, to add, update and delete their data in the index so that aggregators can discover them.

Nodes store their profiles on their website or through a dedicated profile host and then request them to be referenced in the index. The index validates that the profile meets the requirements of its associated schema(s). The index does not store the entire profile; instead it stores only certain fields that can then be used by aggregators to find profiles that match various search criteria. The index will return a list of nodes and their URLs (profile_urls) so that aggregators can then download from each node it's profile data for use in their apps.

Automated profile deletion

Some profile data may be time-sensitive or may need to be deleted after a certain period of time. The index service will automatically mark a profile as deleted provided the profile has an expires field set in the profile data. The expires field should be a date in the Unix timestamp format (seconds since 1970-01-01, e.g., 1729555200 for 2024-10-22).