Chart Availability

GET https://api.podengine.ai/api/v1/charts/availability

Get the earliest, latest, previous and next chart dates around a selected date

Example request

curl -X GET "https://api.podengine.ai/api/v1/charts/availability?category=top+podcasts&chartType=apple&country=us" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_TOKEN"

const options = {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  }
};

fetch("https://api.podengine.ai/api/v1/charts/availability?category=top+podcasts&chartType=apple&country=us", options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

import requests

headers = {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
}

response = requests.get("https://api.podengine.ai/api/v1/charts/availability?category=top+podcasts&chartType=apple&country=us", headers=headers)
print(response.json())

using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "YOUR_API_TOKEN");
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

var response = await client.GetAsync("https://api.podengine.ai/api/v1/charts/availability?category=top+podcasts&chartType=apple&country=us");
var data = await response.Content.ReadAsStringAsync();
Console.WriteLine(data);

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.podengine.ai/api/v1/charts/availability?category=top+podcasts&chartType=apple&country=us", nil)
	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("Authorization", "YOUR_API_TOKEN")
	
	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

import { PodEngine } from '@podengine/sdk';

const pe = new PodEngine({ apiKey: process.env.PODENGINE_API_KEY });

const data = await pe.charts.getChartAvailability({
  chartType: 'apple',
  category: 'top podcasts',
  country: 'us',
});

console.log(data);

import os

from podengine import PodEngine

pe = PodEngine(api_key=os.environ["PODENGINE_API_KEY"])

data = pe.charts.get_chart_availability(
    chart_type="apple",
    category="top podcasts",
    country="us",
)

print(data)

200

Example response

{
  "status": "OK",
  "data": {
    "options": {
      "chartType": "apple",
      "category": "string",
      "country": "string",
      "date": "string"
    },
    "availability": {
      "earliestChartDate": "string",
      "latestChartDate": "string",
      "selectedDate": "string",
      "selectedDateAvailable": true,
      "previousChartDate": "string",
      "nextChartDate": "string"
    }
  }
}

Request

Query parameters

Get the chart dates available around a selected date

chartTypeenum

The type of chart, one of apple, spotify

applespotify

categorystring

The chart category defaulting to 'top podcasts'. Apple podcasts supports the following: "top podcasts", "arts", "business", "comedy", "education", "fiction", "government", "health & fitness", "history", "kids & family", "leisure", "music", "news", "religion & spirituality", "science", "society & culture", "sports", "technology", "true crime", "tv & film"

countrystring

The country of the chart in ISO 3166-1 alpha-2 format, for example "us". Defaults to us.

datestringregex

The selected chart date in YYYY-MM-DD format. Defaults to the latest chart date.