Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.sdk.anghami.com/llms.txt

Use this file to discover all available pages before exploring further.

The SDK is one API surface across two catalogs — Anghami (music: songs, albums, artists, playlists, lyrics) and OSN+ (video: shows, seasons, episodes, movies). A single OAuth flow, a single API key, a single OpenAPI bundle.

​
Audience

  • App developers integrating Anghami music or OSN+ video into their own client.
  • Server-side integrators building catalog mirrors, recommendations, or analytics on top of Anghami data.
  • AI agents consuming the catalog programmatically — the API is designed to be self-describing through OpenAPI and llms.txt.

​
Service map

                        Anghami + OSN+ API
                                │
       ┌────────────────────────┼────────────────────────┐
       │                        │                        │
   Auth & Keys           Catalog & Search          User & Library
   ───────────           ─────────────────         ────────────────
   AuthService           MusicCatalogService       UserService
   DeveloperService      VideoCatalogService       LibraryService
                         DiscoveryService             PlaylistService
                         SoundtrackService
                                │
                          StreamingService  ← billable
  • Auth & Keys — how callers authenticate. AuthService runs the OAuth + PKCE flow; DeveloperService manages API keys.
  • Catalog & Search — read-only browsing of the public catalog. Idempotent, cacheable, supports batch Get* operations.
  • User & Library — operations bound to an authenticated user. Profile, liked songs/albums, saved movies/shows, followed artists, playback history, playlists.
  • Streaming — the only service that produces a billable event. AcquireMusicStream and AcquireVideoStream return time-limited stream URLs and DRM metadata.
See Content Model for how entities relate, and Streaming & Billing for the billing contract.

​
Cross-content linking

The unique SoundtrackService bridges music and video — given a show or movie, list the songs in its soundtrack; given a song, list the shows or movies that feature it. This is what makes the combined Anghami + OSN+ catalog interesting.

​
Markets and localization

Many catalog endpoints accept a market parameter. Content availability and editorial sections (charts, featured) vary by market. Display fields use Localized where multi-language strings exist.

​
What the SDK does not do

  • No live channels. OSN+ live linear TV is out of scope for the public SDK.
  • No playback reporting RPCs. The acquire is the billable event; you don’t ping us when playback starts/ends.
  • No social graph. Followed artists yes; followed users no.
  • No payments. Subscriptions and entitlements are managed outside the SDK.