toolbench/toolenv/tools/Data/app_store/api.py

import requests
import json
from datetime import date, datetime, timedelta
import os

from typing import Optional, Dict, Union, List


def reviews_by_bundle_id(appid: str, country: str='us', lang: str='en', sort: str=None, page: int=1, toolbench_rapidapi_key: str='088440d910mshef857391f2fc461p17ae9ejsnaebc918926ff'):
    """
    "Get reviews for a chosen app by app bundle id"
    
    """
    url = f"https://app-store2.p.rapidapi.com/reviews/bundle/{appid}"
    querystring = {}
    if country:
        querystring['country'] = country
    if lang:
        querystring['lang'] = lang
    if sort:
        querystring['sort'] = sort
    if page:
        querystring['page'] = page
    
    headers = {
            "X-RapidAPI-Key": toolbench_rapidapi_key,
            "X-RapidAPI-Host": "app-store2.p.rapidapi.com"
        }


    response = requests.get(url, headers=headers, params=querystring)
    try:
        observation = response.json()
    except:
        observation = response.text
    return observation

def reviews_by_id(is_id: str, country: str='us', lang: str='en', page: int=1, sort: str=None, toolbench_rapidapi_key: str='088440d910mshef857391f2fc461p17ae9ejsnaebc918926ff'):
    """
    "Get reviews for a chosen app by app id"
    
    """
    url = f"https://app-store2.p.rapidapi.com/reviews/{is_id}"
    querystring = {}
    if country:
        querystring['country'] = country
    if lang:
        querystring['lang'] = lang
    if page:
        querystring['page'] = page
    if sort:
        querystring['sort'] = sort
    
    headers = {
            "X-RapidAPI-Key": toolbench_rapidapi_key,
            "X-RapidAPI-Host": "app-store2.p.rapidapi.com"
        }


    response = requests.get(url, headers=headers, params=querystring)
    try:
        observation = response.json()
    except:
        observation = response.text
    return observation

def search(q: str, lang: str='en', country: str='us', end_date: str='2023-05-06', start_date: str='2020-01-02', page: int=2, num: int=100, toolbench_rapidapi_key: str='088440d910mshef857391f2fc461p17ae9ejsnaebc918926ff'):
    """
    "Search for apps on the App Store"
    end_date: Date param to filter apps based on release date. Will return apps released on or before this end_date
        start_date: Date param to filter apps based on release date. Will return apps released on or after this start_date
        page: Used for pagination of results.
        num: Number of results to return. 
Default: 50
Max: 200
        
    """
    url = f"https://app-store2.p.rapidapi.com/search"
    querystring = {'q': q, }
    if lang:
        querystring['lang'] = lang
    if country:
        querystring['country'] = country
    if end_date:
        querystring['end_date'] = end_date
    if start_date:
        querystring['start_date'] = start_date
    if page:
        querystring['page'] = page
    if num:
        querystring['num'] = num
    
    headers = {
            "X-RapidAPI-Key": toolbench_rapidapi_key,
            "X-RapidAPI-Host": "app-store2.p.rapidapi.com"
        }


    response = requests.get(url, headers=headers, params=querystring)
    try:
        observation = response.json()
    except:
        observation = response.text
    return observation

def new_free_ios_apps(category: str='6016', country: str='us', lang: str='en', num: int=100, toolbench_rapidapi_key: str='088440d910mshef857391f2fc461p17ae9ejsnaebc918926ff'):
    """
    "Get list of new free ios apps"
    num: Number of results to return. 
Default: 50
Max: 200
        
    """
    url = f"https://app-store2.p.rapidapi.com/ios/new/free"
    querystring = {}
    if category:
        querystring['category'] = category
    if country:
        querystring['country'] = country
    if lang:
        querystring['lang'] = lang
    if num:
        querystring['num'] = num
    
    headers = {
            "X-RapidAPI-Key": toolbench_rapidapi_key,
            "X-RapidAPI-Host": "app-store2.p.rapidapi.com"
        }


    response = requests.get(url, headers=headers, params=querystring)
    try:
        observation = response.json()
    except:
        observation = response.text
    return observation

def new_ios_apps(country: str='us', category: str='6016', lang: str='en', num: int=100, toolbench_rapidapi_key: str='088440d910mshef857391f2fc461p17ae9ejsnaebc918926ff'):
    """
    "Get list of new ios apps"
    num: Number of results to return. 
Default: 50
Max: 200
        
    """
    url = f"https://app-store2.p.rapidapi.com/ios/new"
    querystring = {}
    if country:
        querystring['country'] = country
    if category:
        querystring['category'] = category
    if lang:
        querystring['lang'] = lang
    if num:
        querystring['num'] = num
    
    headers = {
            "X-RapidAPI-Key": toolbench_rapidapi_key,
            "X-RapidAPI-Host": "app-store2.p.rapidapi.com"
        }


    response = requests.get(url, headers=headers, params=querystring)
    try:
        observation = response.json()
    except:
        observation = response.text
    return observation

def top_grossing_mac_apps(category: str='6016', country: str='us', lang: str='en', num: int=100, toolbench_rapidapi_key: str='088440d910mshef857391f2fc461p17ae9ejsnaebc918926ff'):
    """
    "Get list of the top grossing mac apps"
    num: Number of results to return. 
Default: 50
Max: 200
        
    """
    url = f"https://app-store2.p.rapidapi.com/mac/top/grossing"
    querystring = {}
    if category:
        querystring['category'] = category
    if country:
        querystring['country'] = country
    if lang:
        querystring['lang'] = lang
    if num:
        querystring['num'] = num
    
    headers = {
            "X-RapidAPI-Key": toolbench_rapidapi_key,
            "X-RapidAPI-Host": "app-store2.p.rapidapi.com"
        }


    response = requests.get(url, headers=headers, params=querystring)
    try:
        observation = response.json()
    except:
        observation = response.text
    return observation

def top_grossing_ipad_apps(country: str='us', lang: str='en', category: str='6016', num: int=100, toolbench_rapidapi_key: str='088440d910mshef857391f2fc461p17ae9ejsnaebc918926ff'):
    """
    "Get list of the top grossing ipad apps"
    num: Number of results to return. 
Default: 50
Max: 200
        
    """
    url = f"https://app-store2.p.rapidapi.com/ipad/top/grossing"
    querystring = {}
    if country:
        querystring['country'] = country
    if lang:
        querystring['lang'] = lang
    if category:
        querystring['category'] = category
    if num:
        querystring['num'] = num
    
    headers = {
            "X-RapidAPI-Key": toolbench_rapidapi_key,
            "X-RapidAPI-Host": "app-store2.p.rapidapi.com"
        }


    response = requests.get(url, headers=headers, params=querystring)
    try:
        observation = response.json()
    except:
        observation = response.text
    return observation

def top_grossing_ios_apps(country: str='us', category: str='6016', lang: str='en', num: int=100, toolbench_rapidapi_key: str='088440d910mshef857391f2fc461p17ae9ejsnaebc918926ff'):
    """
    "Get list of the top grossing ios apps"
    num: Number of results to return. 
Default: 50
Max: 200
        
    """
    url = f"https://app-store2.p.rapidapi.com/ios/top/grossing"
    querystring = {}
    if country:
        querystring['country'] = country
    if category:
        querystring['category'] = category
    if lang:
        querystring['lang'] = lang
    if num:
        querystring['num'] = num
    
    headers = {
            "X-RapidAPI-Key": toolbench_rapidapi_key,
            "X-RapidAPI-Host": "app-store2.p.rapidapi.com"
        }


    response = requests.get(url, headers=headers, params=querystring)
    try:
        observation = response.json()
    except:
        observation = response.text
    return observation

def top_paid_mac_apps(category: str='6016', country: str='us', lang: str='en', num: int=100, toolbench_rapidapi_key: str='088440d910mshef857391f2fc461p17ae9ejsnaebc918926ff'):
    """
    "Get list of the top paid mac apps"
    num: Number of results to return. 
Default: 50
Max: 200
        
    """
    url = f"https://app-store2.p.rapidapi.com/mac/top/paid"
    querystring = {}
    if category:
        querystring['category'] = category
    if country:
        querystring['country'] = country
    if lang:
        querystring['lang'] = lang
    if num:
        querystring['num'] = num
    
    headers = {
            "X-RapidAPI-Key": toolbench_rapidapi_key,
            "X-RapidAPI-Host": "app-store2.p.rapidapi.com"
        }


    response = requests.get(url, headers=headers, params=querystring)
    try:
        observation = response.json()
    except:
        observation = response.text
    return observation

def top_paid_ipad_apps(category: str='6016', country: str='us', lang: str='en', num: int=100, toolbench_rapidapi_key: str='088440d910mshef857391f2fc461p17ae9ejsnaebc918926ff'):
    """
    "Get list of the top paid ipad apps"
    num: Number of results to return. 
Default: 50
Max: 200
        
    """
    url = f"https://app-store2.p.rapidapi.com/ipad/top/paid"
    querystring = {}
    if category:
        querystring['category'] = category
    if country:
        querystring['country'] = country
    if lang:
        querystring['lang'] = lang
    if num:
        querystring['num'] = num
    
    headers = {
            "X-RapidAPI-Key": toolbench_rapidapi_key,
            "X-RapidAPI-Host": "app-store2.p.rapidapi.com"
        }


    response = requests.get(url, headers=headers, params=querystring)
    try:
        observation = response.json()
    except:
        observation = response.text
    return observation

def top_paid_ios_apps(lang: str='en', category: str='6016', country: str='us', num: int=100, toolbench_rapidapi_key: str='088440d910mshef857391f2fc461p17ae9ejsnaebc918926ff'):
    """
    "Get list of the top paid ios apps"
    num: Number of results to return. 
Default: 50
Max: 200
        
    """
    url = f"https://app-store2.p.rapidapi.com/ios/top/paid"
    querystring = {}
    if lang:
        querystring['lang'] = lang
    if category:
        querystring['category'] = category
    if country:
        querystring['country'] = country
    if num:
        querystring['num'] = num
    
    headers = {
            "X-RapidAPI-Key": toolbench_rapidapi_key,
            "X-RapidAPI-Host": "app-store2.p.rapidapi.com"
        }


    response = requests.get(url, headers=headers, params=querystring)
    try:
        observation = response.json()
    except:
        observation = response.text
    return observation

def top_free_mac_apps(lang: str='en', category: str='6016', country: str='us', num: int=100, toolbench_rapidapi_key: str='088440d910mshef857391f2fc461p17ae9ejsnaebc918926ff'):
    """
    "Get list of the top free mac apps"
    num: Number of results to return. 
Default: 50
Max: 200
        
    """
    url = f"https://app-store2.p.rapidapi.com/mac/top/free"
    querystring = {}
    if lang:
        querystring['lang'] = lang
    if category:
        querystring['category'] = category
    if country:
        querystring['country'] = country
    if num:
        querystring['num'] = num
    
    headers = {
            "X-RapidAPI-Key": toolbench_rapidapi_key,
            "X-RapidAPI-Host": "app-store2.p.rapidapi.com"
        }


    response = requests.get(url, headers=headers, params=querystring)
    try:
        observation = response.json()
    except:
        observation = response.text
    return observation

def top_free_ipad_apps(country: str='us', category: str='6016', lang: str='en', num: int=100, toolbench_rapidapi_key: str='088440d910mshef857391f2fc461p17ae9ejsnaebc918926ff'):
    """
    "Get list of the top free Ipad apps"
    num: Number of results to return. 
Default: 50
Max: 200
        
    """
    url = f"https://app-store2.p.rapidapi.com/ipad/top/free"
    querystring = {}
    if country:
        querystring['country'] = country
    if category:
        querystring['category'] = category
    if lang:
        querystring['lang'] = lang
    if num:
        querystring['num'] = num
    
    headers = {
            "X-RapidAPI-Key": toolbench_rapidapi_key,
            "X-RapidAPI-Host": "app-store2.p.rapidapi.com"
        }


    response = requests.get(url, headers=headers, params=querystring)
    try:
        observation = response.json()
    except:
        observation = response.text
    return observation

def new_paid_ios_apps(country: str='us', lang: str='en', category: str='6016', num: int=100, toolbench_rapidapi_key: str='088440d910mshef857391f2fc461p17ae9ejsnaebc918926ff'):
    """
    "Get list of new paid ios apps"
    num: Number of results to return. 
Default: 50
Max: 200
        
    """
    url = f"https://app-store2.p.rapidapi.com/ios/new/paid"
    querystring = {}
    if country:
        querystring['country'] = country
    if lang:
        querystring['lang'] = lang
    if category:
        querystring['category'] = category
    if num:
        querystring['num'] = num
    
    headers = {
            "X-RapidAPI-Key": toolbench_rapidapi_key,
            "X-RapidAPI-Host": "app-store2.p.rapidapi.com"
        }


    response = requests.get(url, headers=headers, params=querystring)
    try:
        observation = response.json()
    except:
        observation = response.text
    return observation

def top_free_ios_apps(lang: str='en', country: str='us', num: int=100, category: str='6016', toolbench_rapidapi_key: str='088440d910mshef857391f2fc461p17ae9ejsnaebc918926ff'):
    """
    "Get list of the top free apps on IOS"
    num: Number of results to return. 
Default: 50
Max: 200
        
    """
    url = f"https://app-store2.p.rapidapi.com/ios/top/free"
    querystring = {}
    if lang:
        querystring['lang'] = lang
    if country:
        querystring['country'] = country
    if num:
        querystring['num'] = num
    if category:
        querystring['category'] = category
    
    headers = {
            "X-RapidAPI-Key": toolbench_rapidapi_key,
            "X-RapidAPI-Host": "app-store2.p.rapidapi.com"
        }


    response = requests.get(url, headers=headers, params=querystring)
    try:
        observation = response.json()
    except:
        observation = response.text
    return observation

def privacy_permissions_by_id(is_id: str, toolbench_rapidapi_key: str='088440d910mshef857391f2fc461p17ae9ejsnaebc918926ff'):
    """
    "Get privacy permissions for an app by ID"
    
    """
    url = f"https://app-store2.p.rapidapi.com/privacy/{is_id}"
    querystring = {}
    
    headers = {
            "X-RapidAPI-Key": toolbench_rapidapi_key,
            "X-RapidAPI-Host": "app-store2.p.rapidapi.com"
        }


    response = requests.get(url, headers=headers, params=querystring)
    try:
        observation = response.json()
    except:
        observation = response.text
    return observation

def categories(toolbench_rapidapi_key: str='088440d910mshef857391f2fc461p17ae9ejsnaebc918926ff'):
    """
    "Get App Store categories and their matching category codes"
    
    """
    url = f"https://app-store2.p.rapidapi.com/categories"
    querystring = {}
    
    headers = {
            "X-RapidAPI-Key": toolbench_rapidapi_key,
            "X-RapidAPI-Host": "app-store2.p.rapidapi.com"
        }


    response = requests.get(url, headers=headers, params=querystring)
    try:
        observation = response.json()
    except:
        observation = response.text
    return observation

def similar_apps_by_id(is_id: str, toolbench_rapidapi_key: str='088440d910mshef857391f2fc461p17ae9ejsnaebc918926ff'):
    """
    "Get a list of apps similar to the provided app"
    
    """
    url = f"https://app-store2.p.rapidapi.com/similar/{is_id}"
    querystring = {}
    
    headers = {
            "X-RapidAPI-Key": toolbench_rapidapi_key,
            "X-RapidAPI-Host": "app-store2.p.rapidapi.com"
        }


    response = requests.get(url, headers=headers, params=querystring)
    try:
        observation = response.json()
    except:
        observation = response.text
    return observation

def similar_apps_by_bundle_id(appid: str, toolbench_rapidapi_key: str='088440d910mshef857391f2fc461p17ae9ejsnaebc918926ff'):
    """
    "Get a list of apps similar to the provided app by app bundle ID"
    
    """
    url = f"https://app-store2.p.rapidapi.com/similar/bundle/{appid}"
    querystring = {}
    
    headers = {
            "X-RapidAPI-Key": toolbench_rapidapi_key,
            "X-RapidAPI-Host": "app-store2.p.rapidapi.com"
        }


    response = requests.get(url, headers=headers, params=querystring)
    try:
        observation = response.json()
    except:
        observation = response.text
    return observation

def applications_by_developer(is_id: str, lang: str='en', toolbench_rapidapi_key: str='088440d910mshef857391f2fc461p17ae9ejsnaebc918926ff'):
    """
    "Get a list of apps published by a chosen developer"
    
    """
    url = f"https://app-store2.p.rapidapi.com/developer/{is_id}"
    querystring = {}
    if lang:
        querystring['lang'] = lang
    
    headers = {
            "X-RapidAPI-Key": toolbench_rapidapi_key,
            "X-RapidAPI-Host": "app-store2.p.rapidapi.com"
        }


    response = requests.get(url, headers=headers, params=querystring)
    try:
        observation = response.json()
    except:
        observation = response.text
    return observation

def application_details_by_bundle_id(appid: str, country: str='us', lang: str='en', toolbench_rapidapi_key: str='088440d910mshef857391f2fc461p17ae9ejsnaebc918926ff'):
    """
    "Get Application information by app bundle id."
    
    """
    url = f"https://app-store2.p.rapidapi.com/app/bundle/{appid}"
    querystring = {}
    if country:
        querystring['country'] = country
    if lang:
        querystring['lang'] = lang
    
    headers = {
            "X-RapidAPI-Key": toolbench_rapidapi_key,
            "X-RapidAPI-Host": "app-store2.p.rapidapi.com"
        }


    response = requests.get(url, headers=headers, params=querystring)
    try:
        observation = response.json()
    except:
        observation = response.text
    return observation

def application_details_by_id(is_id: str, country: str='us', lang: str='en', toolbench_rapidapi_key: str='088440d910mshef857391f2fc461p17ae9ejsnaebc918926ff'):
    """
    "Get Application information by app id."
    
    """
    url = f"https://app-store2.p.rapidapi.com/app/{is_id}"
    querystring = {}
    if country:
        querystring['country'] = country
    if lang:
        querystring['lang'] = lang
    
    headers = {
            "X-RapidAPI-Key": toolbench_rapidapi_key,
            "X-RapidAPI-Host": "app-store2.p.rapidapi.com"
        }


    response = requests.get(url, headers=headers, params=querystring)
    try:
        observation = response.json()
    except:
        observation = response.text
    return observation