Getting Started with Cherry.tv Affiliates API

The Cherry.tv Affiliates API allows you to programmatically access model information, room data, and affiliate links for integration into your applications.

Base URL

All API requests should be made to:

https://api.cherry.tv

Authentication

The API uses API Key authentication passed as a query parameter. You'll need to include your API key in every request:

?apiKey=YOUR_API_KEY

Example Request

curl "https://api.cherry.tv/affiliates/v1/models?apiKey=YOUR_API_KEY"

Response Format

All API responses are returned in JSON format. The API follows RESTful conventions and returns appropriate HTTP status codes.

Success Response

{
  "model": {
    "id": "12345",
    "username": "examplemodel",
    "name": "Example Model",
    // ... additional model data
  },
  "links": {
    "affiliate_url": "https://cherry.tv/examplemodel?ref=affiliate123",
    "room_url": "https://cherry.tv/examplemodel"
  },
  "embed": {
    "stream_url": "https://cherry.tv/embed/examplemodel",
    "room_url": {},
    "room_url_revshare": {}
  },
  "room": {
    "status": 1,
    "thumbnail": {},
    "viewers": 42,
    "subject": {}
  }
}

Error Response

{
  "error": "Invalid API key",
  "statusCode": 401
}

Rate Limiting

Please be respectful with your API usage. While specific rate limits aren't documented, we recommend:

Caching responses when possible
Implementing exponential backoff for retries
Not making more than 10 requests per second

Next Steps

List Models - Get a list of available models
Get Model Info - Get detailed information about a specific model
Data Models - Understand the data structures returned by the API

Support

If you need help or have questions about the API, please contact your account manager or reach out to our developer support team.

Getting Started

On this page