Documentation
Cherry.tv Developer Documentation
Welcome to the Cherry.tv API documentation. You'll find comprehensive guides and documentation to help you start working with the Cherry.tv API as quickly as possible, as well as support if you get stuck. Let's jump right in!
Quick Start
New to Cherry.tv APIs? Start here:
- Getting Started with Affiliates API - Learn the basics of authentication and making your first API calls
- Data Models - Understand the data structures and schemas
- Code Examples - See practical implementation examples in multiple languages
API Reference
Affiliates API
The Affiliates API allows you to programmatically access model information, room data, and affiliate links.
- List Models - Get a paginated list of models with filtering options
- Get Model Info - Retrieve detailed information about a specific model
- Data Models - Complete reference for all data structures
- Code Examples - Implementation examples in JavaScript, Python, PHP, and more
- Use Cases & Patterns - Common implementation patterns and best practices
Base URL: https://api.cherry.tv
Authentication: API Key (query parameter)
Account API
- User Registration - Handle user account creation
Guides & Tutorials
Embedding
- Embed Shows using iframe - Learn how to embed Cherry.tv shows on your website using iframes
Features Overview
🔍 Model Discovery
- Search and filter models by gender, tags, language, and status
- Get real-time information about online models
- Access model profiles, stats, and media
🔗 Affiliate Integration
- Generate affiliate links with custom tracking parameters
- Access pre-built affiliate URLs for each model
- Track campaigns and performance
📱 Embedding & Integration
- Embed live streams using iframe
- Get stream URLs for custom players
- Mobile-friendly integration options
📊 Real-time Data
- Live model status (online/offline/private/away)
- Current viewer counts
- Room information and thumbnails
Getting Your API Key
To get started with the Cherry.tv APIs, you'll need an API key. Contact your account manager or reach out to our developer support team to obtain your credentials.
Rate Limits & Best Practices
- Implement caching to reduce API calls
- Use pagination for large datasets
- Handle errors gracefully with retry logic
- Never expose API keys in client-side code
Support
Need help? Here are your options:
- Documentation Issues: Check our comprehensive guides and examples
- Technical Support: Contact your account manager
- Feature Requests: Reach out to our developer support team
What's New
- ✅ Comprehensive code examples in multiple languages
- ✅ Detailed data model documentation
- ✅ Use case implementations and patterns
- ✅ Mobile integration examples
- ✅ Error handling best practices
Ready to start building? Check out the Getting Started guide or dive into the API Reference.