Skip to content

InstagramApi.md

Latest commit

 

History

History
1478 lines (1018 loc) · 43.1 KB

InstagramApi.md

File metadata and controls

1478 lines (1018 loc) · 43.1 KB
Raw

ScrapeBadger\InstagramApi

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

Method HTTP request Description
instagramAboutThisAccount() GET /v1/instagram/users/{username}/about About this account
instagramBlendedTopSearch() GET /v1/instagram/search/top Blended top search
instagramGetActiveStories() GET /v1/instagram/users/{username}/stories Get active stories
instagramGetAudioTrack() GET /v1/instagram/audio/{audio_id} Get audio track
instagramGetComments() GET /v1/instagram/media/{code}/comments Get comments
instagramGetFollowers() GET /v1/instagram/users/{username}/followers Get followers
instagramGetFollowing() GET /v1/instagram/users/{username}/following Get following
instagramGetHashtagInfo() GET /v1/instagram/hashtags/{tag} Get hashtag info
instagramGetHighlights() GET /v1/instagram/users/{username}/highlights Get highlights
instagramGetLikers() GET /v1/instagram/media/{code}/likers Get likers
instagramGetLocation() GET /v1/instagram/locations/{location_pk} Get location
instagramGetPostReelDetail() GET /v1/instagram/media/{code} Get post/reel detail
instagramGetProfile() GET /v1/instagram/users/{username} Get profile
instagramGetTaggedPosts() GET /v1/instagram/users/{username}/tagged Get tagged posts
instagramGetUserPosts() GET /v1/instagram/users/{username}/posts Get user posts
instagramGetUserReels() GET /v1/instagram/users/{username}/reels Get user reels
instagramHealth() GET /v1/instagram/health Health
instagramHealthHead() HEAD /v1/instagram/health Health
instagramRecentHashtagPosts() GET /v1/instagram/hashtags/{tag}/recent Recent hashtag posts
instagramRelatedProfiles() GET /v1/instagram/users/{username}/related Related profiles
instagramSearchHashtags() GET /v1/instagram/search/hashtags Search hashtags
instagramSearchUsers() GET /v1/instagram/search/users Search users
instagramTopHashtagPosts() GET /v1/instagram/hashtags/{tag}/top Top hashtag posts

instagramAboutThisAccount()

instagramAboutThisAccount($username): mixed

About this account

Temporarily unavailable. The authenticated Instagram tier is offline, so this endpoint currently returns 503 temporarily_unavailable (not billed, Retry-After set) — see https://docs.scrapebadger.com/instagram/overview. Country, join date and former usernames.

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\InstagramApi(
    // 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
);
$username = 'username_example'; // string

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

Parameters

Name Type Description Notes
username string

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]

instagramBlendedTopSearch()

instagramBlendedTopSearch($query): mixed

Blended top search

Temporarily unavailable. The authenticated Instagram tier is offline, so this endpoint currently returns 503 temporarily_unavailable (not billed, Retry-After set) — see https://docs.scrapebadger.com/instagram/overview.

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\InstagramApi(
    // 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

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

Parameters

Name Type Description Notes
query string

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]

instagramGetActiveStories()

instagramGetActiveStories($username): mixed

Get active stories

Temporarily unavailable. The authenticated Instagram tier is offline, so this endpoint currently returns 503 temporarily_unavailable (not billed, Retry-After set) — see https://docs.scrapebadger.com/instagram/overview. Active stories (account pool only).

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\InstagramApi(
    // 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
);
$username = 'username_example'; // string

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

Parameters

Name Type Description Notes
username string

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]

instagramGetAudioTrack()

instagramGetAudioTrack($audio_id): mixed

Get audio track

Temporarily unavailable. The authenticated Instagram tier is offline, so this endpoint currently returns 503 temporarily_unavailable (not billed, Retry-After set) — see https://docs.scrapebadger.com/instagram/overview.

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\InstagramApi(
    // 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
);
$audio_id = 'audio_id_example'; // string

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

Parameters

Name Type Description Notes
audio_id string

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]

instagramGetComments()

instagramGetComments($code, $amount, $cursor): mixed

Get comments

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\InstagramApi(
    // 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
);
$code = 'code_example'; // string
$amount = 20; // int
$cursor = 'cursor_example'; // string

try {
    $result = $apiInstance->instagramGetComments($code, $amount, $cursor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstagramApi->instagramGetComments: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
code string
amount int [optional] [default to 20]
cursor string [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]

instagramGetFollowers()

instagramGetFollowers($username, $amount, $cursor, $order): mixed

Get followers

Temporarily unavailable. The authenticated Instagram tier is offline, so this endpoint currently returns 503 temporarily_unavailable (not billed, Retry-After set) — see https://docs.scrapebadger.com/instagram/overview. Followers list, paginated (account pool).

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\InstagramApi(
    // 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
);
$username = 'username_example'; // string
$amount = 50; // int
$cursor = 'cursor_example'; // string
$order = 'order_example'; // string | date_followed_latest | date_followed_earliest

try {
    $result = $apiInstance->instagramGetFollowers($username, $amount, $cursor, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstagramApi->instagramGetFollowers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
username string
amount int [optional] [default to 50]
cursor string [optional]
order string date_followed_latest date_followed_earliest

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]

instagramGetFollowing()

instagramGetFollowing($username, $amount, $cursor): mixed

Get following

Temporarily unavailable. The authenticated Instagram tier is offline, so this endpoint currently returns 503 temporarily_unavailable (not billed, Retry-After set) — see https://docs.scrapebadger.com/instagram/overview.

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\InstagramApi(
    // 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
);
$username = 'username_example'; // string
$amount = 50; // int
$cursor = 'cursor_example'; // string

try {
    $result = $apiInstance->instagramGetFollowing($username, $amount, $cursor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstagramApi->instagramGetFollowing: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
username string
amount int [optional] [default to 50]
cursor string [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]

instagramGetHashtagInfo()

instagramGetHashtagInfo($tag): mixed

Get hashtag info

Temporarily unavailable. The authenticated Instagram tier is offline, so this endpoint currently returns 503 temporarily_unavailable (not billed, Retry-After set) — see https://docs.scrapebadger.com/instagram/overview.

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\InstagramApi(
    // 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
);
$tag = 'tag_example'; // string

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

Parameters

Name Type Description Notes
tag string

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]

instagramGetHighlights()

instagramGetHighlights($username): mixed

Get highlights

Temporarily unavailable. The authenticated Instagram tier is offline, so this endpoint currently returns 503 temporarily_unavailable (not billed, Retry-After set) — see https://docs.scrapebadger.com/instagram/overview.

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\InstagramApi(
    // 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
);
$username = 'username_example'; // string

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

Parameters

Name Type Description Notes
username string

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]

instagramGetLikers()

instagramGetLikers($code): mixed

Get likers

Temporarily unavailable. The authenticated Instagram tier is offline, so this endpoint currently returns 503 temporarily_unavailable (not billed, Retry-After set) — see https://docs.scrapebadger.com/instagram/overview.

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\InstagramApi(
    // 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
);
$code = 'code_example'; // string

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

Parameters

Name Type Description Notes
code string

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]

instagramGetLocation()

instagramGetLocation($location_pk): mixed

Get location

Temporarily unavailable. The authenticated Instagram tier is offline, so this endpoint currently returns 503 temporarily_unavailable (not billed, Retry-After set) — see https://docs.scrapebadger.com/instagram/overview.

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\InstagramApi(
    // 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
);
$location_pk = 56; // int

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

Parameters

Name Type Description Notes
location_pk int

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]

instagramGetPostReelDetail()

instagramGetPostReelDetail($code): mixed

Get post/reel detail

Single post or reel: caption, media, counts, tags, location, carousel.

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\InstagramApi(
    // 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
);
$code = 'code_example'; // string

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

Parameters

Name Type Description Notes
code string

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]

instagramGetProfile()

instagramGetProfile($username): mixed

Get profile

Full public profile: bio, counts, verification, business contact, links.

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\InstagramApi(
    // 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
);
$username = 'username_example'; // string

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

Parameters

Name Type Description Notes
username string

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]

instagramGetTaggedPosts()

instagramGetTaggedPosts($username, $amount, $cursor): mixed

Get tagged posts

Temporarily unavailable. The authenticated Instagram tier is offline, so this endpoint currently returns 503 temporarily_unavailable (not billed, Retry-After set) — see https://docs.scrapebadger.com/instagram/overview.

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\InstagramApi(
    // 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
);
$username = 'username_example'; // string
$amount = 20; // int
$cursor = 'cursor_example'; // string

try {
    $result = $apiInstance->instagramGetTaggedPosts($username, $amount, $cursor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstagramApi->instagramGetTaggedPosts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
username string
amount int [optional] [default to 20]
cursor string [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]

instagramGetUserPosts()

instagramGetUserPosts($username, $amount, $cursor): mixed

Get user posts

Timeline posts, paginated.

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\InstagramApi(
    // 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
);
$username = 'username_example'; // string
$amount = 20; // int
$cursor = 'cursor_example'; // string

try {
    $result = $apiInstance->instagramGetUserPosts($username, $amount, $cursor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstagramApi->instagramGetUserPosts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
username string
amount int [optional] [default to 20]
cursor string [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]

instagramGetUserReels()

instagramGetUserReels($username, $amount, $cursor): mixed

Get user reels

Temporarily unavailable. The authenticated Instagram tier is offline, so this endpoint currently returns 503 temporarily_unavailable (not billed, Retry-After set) — see https://docs.scrapebadger.com/instagram/overview.

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\InstagramApi(
    // 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
);
$username = 'username_example'; // string
$amount = 20; // int
$cursor = 'cursor_example'; // string

try {
    $result = $apiInstance->instagramGetUserReels($username, $amount, $cursor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstagramApi->instagramGetUserReels: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
username string
amount int [optional] [default to 20]
cursor string [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]

instagramHealth()

instagramHealth(): mixed

Health

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\InstagramApi(
    // 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->instagramHealth();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstagramApi->instagramHealth: ', $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]

instagramHealthHead()

instagramHealthHead(): mixed

Health

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\InstagramApi(
    // 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->instagramHealthHead();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstagramApi->instagramHealthHead: ', $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]

instagramRecentHashtagPosts()

instagramRecentHashtagPosts($tag, $amount, $cursor): mixed

Recent hashtag posts

Temporarily unavailable. The authenticated Instagram tier is offline, so this endpoint currently returns 503 temporarily_unavailable (not billed, Retry-After set) — see https://docs.scrapebadger.com/instagram/overview.

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\InstagramApi(
    // 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
);
$tag = 'tag_example'; // string
$amount = 20; // int
$cursor = 'cursor_example'; // string

try {
    $result = $apiInstance->instagramRecentHashtagPosts($tag, $amount, $cursor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstagramApi->instagramRecentHashtagPosts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
tag string
amount int [optional] [default to 20]
cursor string [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]

instagramRelatedProfiles()

instagramRelatedProfiles($username): mixed

Related profiles

Temporarily unavailable. The authenticated Instagram tier is offline, so this endpoint currently returns 503 temporarily_unavailable (not billed, Retry-After set) — see https://docs.scrapebadger.com/instagram/overview.

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\InstagramApi(
    // 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
);
$username = 'username_example'; // string

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

Parameters

Name Type Description Notes
username string

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]

instagramSearchHashtags()

instagramSearchHashtags($query): mixed

Search hashtags

Temporarily unavailable. The authenticated Instagram tier is offline, so this endpoint currently returns 503 temporarily_unavailable (not billed, Retry-After set) — see https://docs.scrapebadger.com/instagram/overview.

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\InstagramApi(
    // 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

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

Parameters

Name Type Description Notes
query string

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]

instagramSearchUsers()

instagramSearchUsers($query): mixed

Search users

Temporarily unavailable. The authenticated Instagram tier is offline, so this endpoint currently returns 503 temporarily_unavailable (not billed, Retry-After set) — see https://docs.scrapebadger.com/instagram/overview.

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\InstagramApi(
    // 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

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

Parameters

Name Type Description Notes
query string

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]

instagramTopHashtagPosts()

instagramTopHashtagPosts($tag, $amount, $cursor): mixed

Top hashtag posts

Temporarily unavailable. The authenticated Instagram tier is offline, so this endpoint currently returns 503 temporarily_unavailable (not billed, Retry-After set) — see https://docs.scrapebadger.com/instagram/overview.

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\InstagramApi(
    // 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
);
$tag = 'tag_example'; // string
$amount = 20; // int
$cursor = 'cursor_example'; // string

try {
    $result = $apiInstance->instagramTopHashtagPosts($tag, $amount, $cursor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstagramApi->instagramTopHashtagPosts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
tag string
amount int [optional] [default to 20]
cursor string [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]