openapi: 3.0.0
info:
  version: '3.32.31'
  title: 'The Delphi API'
  description: >-
    The Delphi API exposes public and private data like streaming and social metrics from various DSPs.

    In addition to streaming and demographic data, DSPs like Apple Music, Spotify and Amazon Music provide the metadata
    for Playlists. Metadata related to Artists, Tracks, Products, etc. is based on curated data synced from
    [GRAS](https://data-analytics.atlassian.net/wiki/spaces/DDPS/pages/500236646/GRAS). You can find more related
    information in [The Delphi API - Data Points & Availability](https://data-analytics.atlassian.net/wiki/spaces/DDPS/pages/332955861/Data+Points+Availability).

    You can find an overview, additional documentation and resources by checking out
    [**The Delphi API**](https://data-analytics.atlassian.net/wiki/spaces/DDPS/pages/304677323/The+Delphi+API)
    in Confluence, including some supplementary technical documentation in
    [The Delphi API - Endpoints & Parameters](https://data-analytics.atlassian.net/wiki/spaces/DDPS/pages/427720719/Endpoints+Parameters).

    ### Tips


    - While viewing a response object below, the default view is **Example Value**. By clicking **Schema** you can see
      the full details for every field and object, including things like type and description.
    - Get a copy of the Postman collection and environments from
      [Postman Setup & Collection](https://data-analytics.atlassian.net/wiki/spaces/DDPS/pages/333021327/Postman+Setup+Collection).
    - You can even run requests from the Swagger UI page. You'll need to click the **Authorize** button, and paste
      in your token from the `/oauth/token` endpoint.
servers:
  - description: API v3
    url: /v3
tags:
  - name: Auth
    description: Authentication and authorization related endpoints
  - name: Ads
    description: Ads/Campaigns/Projects related resources
  - name: Artists
    description: Artist related resources
  - name: Charts
    description: Chart related resources
  - name: Companies
    description: Company/business/label related resources
  - name: Data Health
    description: Data Health related resources
  - name: DSPs
    description: DSP related resources
  - name: Playlists
    description: Playlist related resources
  - name: Stations
    description: Stations related resources
  - name: Products
    description: Product related resources
  - name: Regions
    description: Region related resources
  - name: Search
    description: Search related resources
  - name: Streams
    description: Streaming related resources
  - name: Tracks
    description: Track related resources
  - name: Videos
    description: Video related resources
  - name: All Resources
    description: Contains ALL resource-related endpoints
  - name: Application
    description: General application-related endpoints
  - name: Shazam
    description: Shazam related endpoints

paths:
  ############################################################################
  # Resource Routes
  ############################################################################
  /products:
    $ref: "./paths/products.yaml"
  /products/{product_id}:
    $ref: "./paths/products_product-id.yaml"
  /artists:
    $ref: "./paths/artists.yaml"
  /artists/{artist_id}:
    $ref: "./paths/artists_artist-id.yaml"
  /artists/{artist_id}/followers:
    $ref: "./paths/artists_artist-id_followers.yaml"
  /charts:
    $ref: "./paths/charts.yaml"
  /charts/{chart_id}:
    $ref: "./paths/charts_chart-id.yaml"
  /dsps:
    $ref: "./paths/dsps.yaml"
  /dsps/{dsp_id}:
    $ref: "./paths/dsps_dsp-id.yaml"
  /playlists:
    $ref: "./paths/playlists.yaml"
  /public/playlists:
    $ref: "./paths/public_playlists.yaml"
  /playlists/{playlist_id}:
    $ref: "./paths/playlists_playlist-id.yaml"
  /public/playlists/{playlist_id}:
    $ref: "./paths/public_playlists_playlist-id.yaml"
  /public/playlists/current/{playlist_id}:
    $ref: "./paths/public_playlists_current_playlist-id.yaml"
  /public/playlists/followers:
    $ref: "./paths/public_playlists_followers.yaml"
  /popularity:
    $ref: "./paths/popularity.yaml"
  /regions:
    $ref: "./paths/regions.yaml"
  /regions/{region_id}:
    $ref: "./paths/regions_region-id.yaml"
  /search:
    $ref: "./paths/search.yaml"
  /search/linkfire/links:
    $ref: "./paths/search_linkfire_links.yaml"
  /data-health/chart-positions:
    $ref: "./paths/data-health_chart-positions.yaml"
  /data-health/completeness:
    $ref: "./paths/data-health_completeness.yaml"
  /data-health/dsp/status:
    $ref: "./paths/data-health_dsp_status.yaml"
  /data-health/dsp/status/analytics:
    $ref: "./paths/data-health_dsp_status_analytics.yaml"
  /ads/data-health/dsp/status:
    $ref: "./paths/ads_data-health_dsp_status.yaml"
  /ads/data-health/dsp/status/analytics:
    $ref: "./paths/ads_data-health_dsp_status_analytics.yaml"
  /spotify/charts/data-health/status:
    $ref: "./paths/spotify_charts_data-health_status.yaml"
  /apple-music/charts/data-health/status:
    $ref: "./paths/apple-music_charts_data-health_status.yaml"
  /amazon/charts/data-health/status:
    $ref: "./paths/amazon_charts_data-health_status.yaml"
  /stream-dates:
    $ref: "./paths/stream-dates.yaml"
  /streams:
    $ref: "./paths/streams.yaml"
  /streams/project:
    $ref: "./paths/streams_project.yaml"
  /streams/product-family:
    $ref: "./paths/streams_product-family.yaml"
  /streams/new-listeners:
    $ref: "./paths/streams_new-listeners.yaml"
  /streams/new-listeners/top/country:
    $ref: "./paths/streams_new-listeners_top_country.yaml"
  /streams/insights:
    $ref: "./paths/streams_insights.yaml"
  /streams/country-code/rank:
    $ref: "./paths/streams_country_code_rank.yaml"
  /juno/spotify/streams/latest:
    $ref: "./paths/juno_spotify_streams_latest.yaml"
  /juno/spotify/status/daily:
    $ref: "./paths/juno_spotify_status_daily.yaml"
  /amazon/stations:
    $ref: "./paths/amazon_stations.yaml"
  /tracks:
    $ref: "./paths/tracks.yaml"
  /tracks/{track_id}:
    $ref: "./paths/tracks_track-id.yaml"
  /tracks/brands-tagging:
    $ref: "./paths/tracks_brands-tagging.yaml"
  /labels/{label_id}:
    $ref: "./paths/labels_label-id.yaml"
  /track-positions/playlists:
    $ref: "./paths/track-positions_playlists.yaml"
  /public/track-positions/playlists:
    $ref: "./paths/public_track-positions_playlists.yaml"
  /public/track-positions/playlists/dates:
    $ref: "./paths/public_track-positions_playlists_dates.yaml"
  /track-positions/playlists/summary:
    $ref: "./paths/track-positions_playlists_summary.yaml"
  /public/track-positions/playlists/summary:
    $ref: "./paths/public_track-positions_playlists_summary.yaml"
  /track-positions/playlists/additions:
    $ref: "./paths/track-positions_playlists_additions.yaml"
  /public/track-positions/playlists/additions:
    $ref: "./paths/public_track-positions_playlists_additions.yaml"
  /public/track-positions/previous/playlists:
    $ref: "./paths/public_track-positions_previous_playlists.yaml"
  /public/track-positions/playlists/current-tracklist:
    $ref: "./paths/public_track-positions_current_tracklist.yaml"
  /product-versions:
    $ref: "./paths/product-versions.yaml"
  /product-versions/{product_version_no}:
    $ref: "./paths/product-versions_product-version-no.yaml"
  /video-analytics:
    $ref: "./paths/video-analytics.yaml"
  /video-analytics/project:
    $ref: "./paths/video-analytics_project.yaml"
  /video-analytics/product-family:
    $ref: "./paths/video-analytics_product-family.yaml"
  /videos:
    $ref: "./paths/videos.yaml"
  /videos/{video_id}:
    $ref: "./paths/videos_video-id.yaml"
  /projects:
    $ref: "./paths/projects.yaml"
  /projects/{project_id}:
    $ref: "./paths/projects_project-id.yaml"
  /companies:
    $ref: "./paths/companies.yaml"
  /companies/{company_key}:
    $ref: "./paths/companies_companies-key.yaml"
  /repertoire-owners:
    $ref: "./paths/repertoire-owners.yaml"
  /repertoire-owners/{rep_owner_key}:
    $ref: "./paths/repertoire-owners_rep-owner-key.yaml"

  ############################################################################
  # Ads Routes
  ############################################################################
  /ads/performance:
    $ref: "./paths/ads_performance.yaml"
  /ads/campaigns/budgets:
    $ref: "./paths/ads_campaigns_budgets.yaml"
  /ads/adsets/budgets:
    $ref: "./paths/ads_adsets_budgets.yaml"

  ############################################################################
  # Video Chart Routes
  ############################################################################
  /video-positions/charts:
    $ref: "./paths/video-positions_charts.yaml"

  /video-positions/charts/summary:
    $ref: "./paths/video-positions_charts_summary.yaml"

  /localization/regions:
    $ref: "./paths/localization_regions.yaml"

  ############################################################################
  # TikTok Routes
  ############################################################################
  /tiktok/tracks/analytics:
    $ref: "./paths/tiktok_tracks_analytics.yaml"

  /tiktok/top/tracks-charts:
    $ref: "./paths/tiktok_top_tracks-charts.yaml"

  /tiktok/top/tracks:
    $ref: "./paths/tiktok_top_tracks.yaml"

  /tiktok/top/tracks/analytics:
    $ref: "./paths/tiktok_top_tracks_analytics.yaml"

  /tiktok/isrc/top/videos:
    $ref: "./paths/tiktok_isrc_top_videos.yaml"

  /tiktok/isrc/top/sounds:
    $ref: "./paths/tiktok_isrc_top_sounds.yaml"

  ############################################################################
  # Shazam Track Chart Positions Routes
  ############################################################################
  /shazam/charts/track-positions:
    $ref: "./paths/shazam_charts_track-positions.yaml"

  /shazam/charts/track-positions/summary:
    $ref: "./paths/shazam_charts_track-positions_summary.yaml"

  /shazam/cities:
    $ref: "./paths/shazam_cities.yaml"

  /shazam/charts/meta:
    $ref: "./paths/shazam_charts_meta.yaml"

  ############################################################################
  # Spotify Track Chart Positions Routes
  ############################################################################
  /spotify/charts:
    $ref: "./paths/spotify_charts.yaml"

  /spotify/charts/tracks:
    $ref: "./paths/spotify_charts_tracks.yaml"

  /spotify/charts/tracks/additions:
    $ref: "./paths/spotify_charts_tracks_additions.yaml"

  /spotify/charts/tracks/removals:
    $ref: "./paths/spotify_charts_tracks_removals.yaml"

  /spotify/tracks/charts:
    $ref: "./paths/spotify_tracks_charts.yaml"

  /spotify/tracks/charts/additions:
    $ref: "./paths/spotify_tracks_charts_additions.yaml"

  /spotify/tracks/charts/removals:
    $ref: "./paths/spotify_tracks_charts_removals.yaml"

  /spotify/tracks/charts/lifetime:
    $ref: "./paths/spotify_tracks_charts_lifetime.yaml"

  /spotify/charts/analytics:
    $ref: "./paths/spotify_charts_analytics.yaml"

  ############################################################################
  # Apple Music Track Chart Positions Routes
  ############################################################################
  /apple-music/charts:
    $ref: "./paths/apple-music_charts.yaml"

  /apple-music/charts/tracks:
    $ref: "./paths/apple-music_charts_tracks.yaml"

  /apple-music/charts/tracks/additions:
    $ref: "./paths/apple-music_charts_additions.yaml"

  /apple-music/charts/tracks/removals:
    $ref: "./paths/apple-music_charts_removals.yaml"

  /apple-music/tracks/charts:
    $ref: "./paths/apple-music_tracks_charts.yaml"

  /apple-music/tracks/charts/additions:
    $ref: "./paths/apple-music_tracks_charts_additions.yaml"

  /apple-music/tracks/charts/removals:
    $ref: "./paths/apple-music_tracks_charts_removals.yaml"

  /apple-music/tracks/charts/lifetime:
    $ref: "./paths/apple-music_tracks_charts_lifetime.yaml"

  /apple-music/charts/analytics:
    $ref: "./paths/apple-music_charts_analytics.yaml"

  ############################################################################
  # Amazon Track Chart Positions Routes
  ############################################################################

  /amazon/charts:
    $ref: "./paths/amazon_charts.yaml"

  /amazon/charts/track-positions:
    $ref: "./paths/amazon_charts_track-positions.yaml"

  /amazon/charts/track-positions/summary:
    $ref: "./paths/amazon_charts_track-positions_summary.yaml"

  ############################################################################
  # Utility Routes
  ############################################################################
  /health:
    $ref: "./paths/health.yaml"

  ############################################################################
  # Auth Routes
  ############################################################################
  /oauth/token:
    $ref: "./paths/oauth_token.yaml"

components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      x-bearerInfoFunc: delphi_api.auth.resource_protector.ProxyResourceProtector.decode_token