Overview

We've put together this API Reference documentation to outline the endpoints available through the Story Protocol API as well as expected Request and Response objects. The Story Protocol API leverages The Graph behind the scenes to index and retrieve data from Story Protocol. Requests can include pagination instructions as well as filters to help you find the information you are looking for.

Authentication

For our Beta release, we have whitelisted a single API Key which should be included in your request Header in order for the API Service to authenticate you. The request Header is as follows:

X-API-KEY: U3RvcnlQcm90b2NvbFRlc3RBUElLRVk=

Note: Failure to include the X-API-KEY Header will result in an Unauthorized error

Request Objects

The API Service accepts the following Request object to help you with pagination and filtering of Responses:

{
  "options": {
    "pagination": {
      "offset": 0,
      "limit": 5
    },
    "where": {
      "creator": "string",
       "receiever": "string",
       "tokenContract": "string",
       "frameworkId": "string",
       "ipAsset": "string",
       "ipId": "string"
    },
    "orderBy": "blockNumber", // or blockTimestamp
    "orderDirection": "DESC" // or "ASC"
  }
}