Skip to main content
POST
/
transactions
List IP Transactions
curl --request POST \
  --url https://api.storyapis.com/api/v4/transactions \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "orderBy": "blockNumber",
  "orderDirection": "desc",
  "pagination": {
    "limit": 20,
    "offset": 0
  },
  "where": {
    "blockGte": 1,
    "blockLte": 1,
    "eventTypes": [
      "<string>"
    ],
    "initiators": [
      "<string>"
    ],
    "ipIds": [
      "<string>"
    ],
    "txHashes": [
      "<string>"
    ]
  }
}
'
{
  "data": [
    {
      "blockNumber": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "eventType": "<string>",
      "id": 123,
      "initiator": "<string>",
      "ipId": "<string>",
      "logIndex": 123,
      "txHash": "<string>"
    }
  ],
  "$schema": "<string>",
  "pagination": {
    "hasMore": true,
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.story.foundation/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint allows you to filter based on event type. Here are the possible string values for the where.eventTypes[] field:
  • “IPRegistered”: When an IP asset is registered
  • “LicenseTermsAttached”: When license terms are attached to an IP asset
  • “DerivativeRegistered”: When a derivative IP asset is registered
  • “DisputeRaised”: When a dispute is raised against an IP asset
  • “DisputeResolved”: When a dispute is resolved
  • “DisputeCancelled”: When a dispute is cancelled
  • “DisputeJudgementSet”: When a judgement is set for a dispute
  • “RoyaltyPaid”: When royalty payments are made

Authorizations

X-Api-Key
string
header
required

Body

application/json
orderBy
enum<string>
default:blockNumber

Field to order results by

Available options:
blockNumber,
createdAt,
eventType,
txHash,
ipId,
initiator
orderDirection
enum<string>
default:desc

Order direction for results

Available options:
asc,
desc
pagination
object

Pagination configuration

where
object

Optional filter options for transactions

Response

OK

data
object[] | null
required

List of IP transactions

$schema
string<uri>
read-only

A URL to the JSON Schema for this object.

Example:

"https://api.storyapis.com/api/v4/TransactionsResponseBodyHuma.json"

pagination
object

Pagination information