POST
/
collections
List Collections
curl --request POST \
  --url https://api.storyapis.com/api/v4/collections \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "orderBy": "updatedAt",
  "orderDirection": "desc",
  "pagination": {
    "limit": 20,
    "offset": 0
  },
  "where": {
    "collectionAddresses": [
      "<string>"
    ],
    "maxAssetCount": 1,
    "minAssetCount": 1
  }
}'
{
  "$schema": "https://api.storyapis.com/api/v4/CollectionsResponseBodyHuma.json",
  "data": [
    {
      "assetCount": 123,
      "cancelledDisputeCount": 123,
      "collectionAddress": "<string>",
      "collectionMetadata": {
        "address": "<string>",
        "chain": "<string>",
        "contractDeployer": "<string>",
        "deployedBlockNumber": 123,
        "name": "<string>",
        "openSeaMetadata": {
          "bannerImageUrl": "<string>",
          "collectionName": "<string>",
          "collectionSlug": "<string>",
          "description": "<string>",
          "discordUrl": "<string>",
          "externalUrl": "<string>",
          "floorPrice": 123,
          "imageUrl": "<string>",
          "lastIngestedAt": "2023-11-07T05:31:56Z",
          "safelistRequestStatus": "<string>",
          "twitterUsername": "<string>"
        },
        "symbol": "<string>",
        "tokenType": "<string>",
        "totalSupply": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "judgedDisputeCount": 123,
      "licensesCount": 123,
      "raisedDisputeCount": 123,
      "resolvedDisputeCount": 123,
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

X-Api-Key
string
header
required

Body

application/json
orderBy
enum<string>
default:updatedAt

Field to order results by (only updatedAt is supported)

Available options:
updatedAt
orderDirection
enum<string>
default:desc

Order direction: asc for least recent, desc for most recent

Available options:
asc,
desc
pagination
object

Pagination configuration

where
object

Optional filter options for collections

Response

OK

data
object[] | null
required

List of enriched collections

$schema
string<uri>

A URL to the JSON Schema for this object.

Examples:

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

pagination
object

Pagination metadata