ScrapeBadger\AppStoreApi

All URIs are relative to https://scrapebadger.com, except if the operation defines another base path.

Method	HTTP request	Description
appStoreGetAppDetail()	GET /v1/app-store/apps/{app_id}	Get app detail
appStoreGetAppReviews()	GET /v1/app-store/apps/{app_id}/reviews	Get app reviews
appStoreGetDeveloperApps()	GET /v1/app-store/developers/{artist_id}	Get developer apps
appStoreListGenres()	GET /v1/app-store/genres	List genres
appStoreListMarkets()	GET /v1/app-store/markets	List markets
appStoreSearchApps()	GET /v1/app-store/search	Search apps
appStoreTopCharts()	GET /v1/app-store/charts	Top charts

`appStoreGetAppDetail()`

appStoreGetAppDetail($app_id, $country, $lang, $include_extras): mixed

Get app detail

App detail: bundle id, version, pricing, ratings, genres, min OS, size, languages, screenshots, in-app purchases and version history.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\AppStoreApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = 'app_id_example'; // string | Numeric trackId (e.g. '310633997') or bundle id (e.g. 'net.whatsapp.WhatsApp').
$country = 'us'; // string
$lang = 'lang_example'; // string | Result language, e.g. 'en_us'
$include_extras = true; // bool | Fetch the storefront page for rating histogram, IAP list, full-res screenshots and App Privacy. Set false to skip the 2nd fetch.

try {
    $result = $apiInstance->appStoreGetAppDetail($app_id, $country, $lang, $include_extras);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppStoreApi->appStoreGetAppDetail: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
app_id	string	Numeric trackId (e.g. '310633997') or bundle id (e.g. 'net.whatsapp.WhatsApp').
country	string		[optional] [default to 'us']
lang	string	Result language, e.g. 'en_us'	[optional]
include_extras	bool	Fetch the storefront page for rating histogram, IAP list, full-res screenshots and App Privacy. Set false to skip the 2nd fetch.	[optional] [default to true]

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`appStoreGetAppReviews()`

appStoreGetAppReviews($app_id, $country, $page, $sort): mixed

Get app reviews

Paginated customer reviews (50 per page, up to 10 pages).

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\AppStoreApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = 'app_id_example'; // string | Numeric trackId, e.g. '310633997'
$country = 'us'; // string
$page = 1; // int | Apple caps reviews at 10 pages
$sort = 'mostRecent'; // string | mostRecent | mostHelpful

try {
    $result = $apiInstance->appStoreGetAppReviews($app_id, $country, $page, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppStoreApi->appStoreGetAppReviews: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
app_id	string	Numeric trackId, e.g. '310633997'
country	string		[optional] [default to 'us']
page	int	Apple caps reviews at 10 pages	[optional] [default to 1]
sort	string	mostRecent	mostHelpful

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`appStoreGetDeveloperApps()`

appStoreGetDeveloperApps($artist_id, $country): mixed

Get developer apps

Developer info and their published apps.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\AppStoreApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$artist_id = 'artist_id_example'; // string | Numeric artistId (developer id)
$country = 'us'; // string

try {
    $result = $apiInstance->appStoreGetDeveloperApps($artist_id, $country);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppStoreApi->appStoreGetDeveloperApps: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
artist_id	string	Numeric artistId (developer id)
country	string		[optional] [default to 'us']

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`appStoreListGenres()`

appStoreListGenres(): mixed

List genres

The Apple App Store genre/category ids.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\AppStoreApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->appStoreListGenres();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppStoreApi->appStoreListGenres: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`appStoreListMarkets()`

appStoreListMarkets(): mixed

List markets

Supported App Store country codes.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\AppStoreApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->appStoreListMarkets();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppStoreApi->appStoreListMarkets: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`appStoreSearchApps()`

appStoreSearchApps($query, $country, $entity, $limit, $offset, $lang): mixed

Search apps

Search the Apple App Store.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\AppStoreApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$query = 'query_example'; // string | Search term, e.g. 'chat'
$country = 'us'; // string | App Store country code
$entity = 'software'; // string | software | iPadSoftware | macSoftware
$limit = 25; // int
$offset = 0; // int
$lang = 'lang_example'; // string | Language, e.g. 'en_us'

try {
    $result = $apiInstance->appStoreSearchApps($query, $country, $entity, $limit, $offset, $lang);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppStoreApi->appStoreSearchApps: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
query	string	Search term, e.g. 'chat'
country	string	App Store country code	[optional] [default to 'us']
entity	string	software	iPadSoftware
limit	int		[optional] [default to 25]
offset	int		[optional] [default to 0]
lang	string	Language, e.g. 'en_us'	[optional]

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`appStoreTopCharts()`

appStoreTopCharts($country, $type, $genre, $limit, $entity): mixed

Top charts

Top charts, optionally scoped to a genre.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\AppStoreApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$country = 'us'; // string
$type = 'top-free'; // string | top-free | top-paid | top-grossing
$genre = 56; // int | Apple genre id (optional), e.g. 6014
$limit = 50; // int
$entity = 'apps'; // string | apps (iPhone) | ipad

try {
    $result = $apiInstance->appStoreTopCharts($country, $type, $genre, $limit, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppStoreApi->appStoreTopCharts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
country	string		[optional] [default to 'us']
type	string	top-free	top-paid
genre	int	Apple genre id (optional), e.g. 6014	[optional]
limit	int		[optional] [default to 50]
entity	string	apps (iPhone)	ipad

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Uh oh!

FilesExpand file tree

AppStoreApi.md

Latest commit

History

AppStoreApi.md

File metadata and controls

ScrapeBadger\AppStoreApi

appStoreGetAppDetail()

Example

Parameters

Return type

Authorization

HTTP request headers

appStoreGetAppReviews()

Example

Parameters

Return type

Authorization

HTTP request headers

appStoreGetDeveloperApps()

Example

Parameters

Return type

Authorization

HTTP request headers

appStoreListGenres()

Example

Parameters

Return type

Authorization

HTTP request headers

appStoreListMarkets()

Example

Parameters

Return type

Authorization

HTTP request headers

appStoreSearchApps()

Example

Parameters

Return type

Authorization

HTTP request headers

appStoreTopCharts()

Example

Parameters

Return type

Authorization

HTTP request headers

`appStoreGetAppDetail()`

`appStoreGetAppReviews()`

`appStoreGetDeveloperApps()`

`appStoreListGenres()`

`appStoreListMarkets()`

`appStoreSearchApps()`

`appStoreTopCharts()`