Resources and APIs
Each XPKit API manages resources. Resources are unstructured (JSON) documents that contain information or configuration and settings.
Throughout the documentation resources are highlighted for your convenience.
Available resources
A list of the available resources and their service URLs:
| Resource | API name | Service URL |
|---|---|---|
| activity | Activities API | https://activities.{% base_domain %} |
| alert | Alerts API | https://alerts.{% base_domain %} |
| catalogue | Catalogue API | https://catalogue.{% base_domain %} |
| custom | Resources API | https://resources.{% base_domain %} |
| experience | Resources API | https://resources.{% base_domain %} |
| export | Exports API | https://exports.{% base_domain %} |
| health | Health API | https://health.{% base_domain %} |
| group | Auth API | https://auth.{% base_domain %} |
| identification | Identifications API | https://identifications.{% base_domain %} |
| job | Jobs API | https://jobs.{% base_domain %} |
| moment | Moments API | https://moments.{% base_domain %} |
| nft | NFTs API | https://nfts.{% base_domain %} |
| notification | Notifications API | https://notifications.{% base_domain %} |
| object | Resources API | https://resources.{% base_domain %} |
| profile | Profiles API | https://profiles.{% base_domain %} |
| queue | Queues API | https://queues.{% base_domain %} |
| socialauth | Social Linking API | https://socialauth.{% base_domain %} |
| souvenir | Souvenirs API | https://souvenirs.{% base_domain %} |
| user | Auth API | https://auth.{% base_domain %} |
| vcc | VCC API | https://vcc.{% base_domain %} |
Each resource and how to interact with them is described in the XPKit Resources section.
Common functionality across all APIs
- All resources contain created and last_modified timestamp fields. These are set automatically by the APIs. Any values provided for these fields in requests will be ignored.
- The default number of resources returned in paginated listing endpoints is 50.
Rate limiting
Applications are limited to 2,000 API requests in a 5 minute period. If requests exceed this limit they will receive back a status code of 429. This will continue until such time that request rates drop below the threshold.
Request sizes
Resources are limited to 8kb in size; any JSON payload that exceeds this limit will be rejected returning a 400 Bad Request. Some APIs permit larger requests, for services that do support this, the increased limit is documented on the API information page under the resources section.