Streams

Get Streams Data (bulk)

Changed on

Get streams filtered by multiple stream IDs, organization IDs, target-token chains and/or target tokens. Same stream objects as GET /streams. Pagination is optional via the page and limit query params (limit is capped at 500); omit both to return all matching streams, except when no filter is provided, in which case a bounded limit is required. Uses POST because the multi-valued filters are sent in the request body; it is a read-only query and is not scoped to the API key's organization.

post/v2/streams/bulk

Request

  • The document declares no server URL.
  • Auth: none declared

Query parameters

pageinteger
limitinteger

Request body

idsUuidUUID[] nullable
organizationIdsUuidUUID[] nullable
targetChainIdsinteger[] nullable

Filter by streams whose target token is on these chains

usersCountboolean
withSnapshotsboolean

Example request

{
  "ids": [
    "248df4b7-aa70-47b8-a036-33ac447e668d"
  ],
  "organizationIds": [
    "248df4b7-aa70-47b8-a036-33ac447e668d"
  ]
}

Response

OK

Example response

{
  "streams": [
    {
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "orgId": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "point": {
        "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
        "orgId": "248df4b7-aa70-47b8-a036-33ac447e668d"
      },
      "rewardToken": {
        "id": "248df4b7-aa70-47b8-a036-33ac447e668d"
      },
      "userId": "248df4b7-aa70-47b8-a036-33ac447e668d"
    }
  ]
}

Changes

  • v260527ba59276Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • v2e6d1393d9ae8Revision changes
    • info

      endpoint added