Affiliate API

📘
API Key Required
Please contact your account manager to receive a key in order to use this API

The affiliate API exposes models data so that they can be used on external websites. The easiest way to get started is using the API Reference from which the API can be tested and which provides code examples. The API Reference contains documentation for all fields.

This guide will provide a high level walk-through the API. Use the API Reference for detailed documentation of all the URL and field definitions

GET /affiliates/v1/models

Parameters

Parameter	Description
username	Search models by username
tag	Search models by tag
language	Search models by spoken language
gender	Search models by gender. These are categories on the frontpage
sort	sorting direction, either asc or desc
order	field to order by, only field viewer is available right now
status	Search models by status. For example all live models
limit	Specifies the maximum number of items that may be returned for a single request. max 250
offset	Specifies the starting point from which to return the items

Fields

Field	Description
model.avatar	URL to the profile photo of the model
links.affiliate_url	Affiliate URL which contains tracking parameters for revenue sharing
embed.stream_url	URL for the embedded show that can be used in the iframe
room.thumbnail_url	Thumbnail image of the current show. This is only available when the show is online

Response

{
  "model": {
    "id": "a49f9b7f-ae04-4dd2-8fb5-b74f122c86de",
    "username": "examplemodel",
    "name": "Model Example Name",
    "avatar": "https://img.cherry.tv/avatar/example.jpg",
    "age": 28,
    "gender": "other",
    "country": null,
    "level": 0,
    "followers": 123,
    "spoken_languages": [
      "en"
    ],
    "tags": [
      "deepthroat",
      "bigtits"
    ]
  },
  "links": {
    "affiliate_url": "https://cherry.tv/exampleusers?utm=test",
    "room_url": "https://cherry.tv/example"
  },
  "embed": {
    "stream_url": "https://cherry.tv/embed/example",
    "room_url": null,
    "room_url_revshare": null
  },
  "room": {
    "subject": "Come and let's have fun together #masturbation",
    "viewers": 0,
    "thumbnail": null,
    "status": "offline"
  }
}

Paging through results using `offset` and `limit`

By default the API will only return the first 100 items. To get a different set of items, you can use the offset and limit parameters in the query string of the GET request.

To page through the available items, first start with limit=0 then subsequent requests with increasing offsets and a fixed limit

…/models?offset=0&limit=100
…/models?offset=100&limit=100
…/models?offset=200&limit=100
…/models?offset=300&limit=100

URL	Description
../models	Returns the first 100 models (default limit is 100)
../models?limit=250	Returns the first 250 models
../models?limit=5&offset=5	Returns models 5...10
../models?offset=10	Returns models 10...110 (default limit is 100)

📘API Key Required

GET /affiliates/v1/models

Paging through results using offset and limit

📘
API Key Required

Paging through results using `offset` and `limit`