Skip to main content
GET
/
platforms
/
{platform}
/
profiles
List profiles
curl --request GET \
  --url https://external-api.streamforge.com/platforms/{platform}/profiles \
  --header 'x-api-key: <api-key>'
{
  "payload": [
    {
      "platform_id": "twitch",
      "id": "<string>",
      "name": "<string>",
      "display_name": "<string>",
      "url": "<string>",
      "description": "<string>",
      "profile_image": "<string>",
      "banner_image": "<string>",
      "language": "<string>",
      "statistics": {
        "followers": 123,
        "views": 123,
        "views_estimated": 123
      },
      "account_type": "<string>",
      "is_mature": true,
      "updated_at": "2023-11-07T05:31:56Z",
      "last_active_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "source": "<string>",
    "received_at": "2023-11-07T05:31:56Z",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

x-api-key
string
header
required

Your API key. Include it in the x-api-key header for all requests.

Path Parameters

platform
enum<string>
required

Platform identifier

Available options:
twitch,
youtube,
tiktok
Example:

"twitch"

Query Parameters

limit
integer
default:10

Maximum number of results per page (1-50, default 10)

Required range: 1 <= x <= 50
Example:

10

cursor
string

Pagination cursor token from previous response

Example:

"eyJpZCI6Ijk4NzY1NDMyMSIsImVuZGVkX2F0IjoiMjAyNC0wNy0wNFQxMTozMDowMC4wMDBaIn0="

Response

Profile found

payload
object[]
meta
object