Skip to content

Latest commit

 

History

History
1908 lines (1374 loc) · 64.9 KB

InstagramApi.md

File metadata and controls

1908 lines (1374 loc) · 64.9 KB

unifapi.InstagramApi

All URIs are relative to https://api.unifapi.com

Method HTTP request Description
instagram_explore_get GET /instagram/explore Browse Instagram's Explore feed
instagram_locations_id_get GET /instagram/locations/{id} Get an Instagram location by id
instagram_locations_id_nearby_get GET /instagram/locations/{id}/nearby List Instagram locations geographically near a given location
instagram_locations_id_posts_get GET /instagram/locations/{id}/posts List posts tagged with an Instagram location
instagram_posts_shortcode_comments_comment_id_replies_get GET /instagram/posts/{shortcode}/comments/{commentId}/replies List replies to an Instagram comment
instagram_posts_shortcode_comments_get GET /instagram/posts/{shortcode}/comments List comments on an Instagram post
instagram_posts_shortcode_get GET /instagram/posts/{shortcode} Get an Instagram post (photo / video / carousel / reel) by shortcode
instagram_reels_recommended_get GET /instagram/reels/recommended Browse Instagram's recommended Reels feed
instagram_resolve_media_id_get GET /instagram/resolve/media-id Convert an Instagram post shortcode into its numeric media_id
instagram_resolve_shortcode_from_media_get GET /instagram/resolve/shortcode-from-media Convert an Instagram numeric media_id into its shortcode
instagram_resolve_shortcode_get GET /instagram/resolve/shortcode Extract a post shortcode from an Instagram URL
instagram_resolve_user_id_get GET /instagram/resolve/user-id Convert an Instagram username into its numeric user_id (pk)
instagram_search_get GET /instagram/search Cross-type Instagram search (posts/reels)
instagram_users_username_followers_get GET /instagram/users/{username}/followers List followers of an Instagram user
instagram_users_username_following_get GET /instagram/users/{username}/following List accounts an Instagram user follows
instagram_users_username_former_usernames_get GET /instagram/users/{username}/former-usernames List former usernames for an Instagram user
instagram_users_username_get GET /instagram/users/{username} Get an Instagram user profile by username
instagram_users_username_highlights_get GET /instagram/users/{username}/highlights List Instagram highlight reels for a user (metadata only)
instagram_users_username_posts_get GET /instagram/users/{username}/posts List feed posts authored by an Instagram user
instagram_users_username_reels_get GET /instagram/users/{username}/reels List reels authored by an Instagram user
instagram_users_username_stories_get GET /instagram/users/{username}/stories List active Instagram stories for a user
instagram_users_username_tagged_posts_get GET /instagram/users/{username}/tagged-posts List posts an Instagram user is tagged in

instagram_explore_get

InstagramExploreGet200Response instagram_explore_get(cursor=cursor)

Browse Instagram's Explore feed

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.instagram_explore_get200_response import InstagramExploreGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.InstagramApi(api_client)
    cursor = 'cursor_example' # str |  (optional)

    try:
        # Browse Instagram's Explore feed
        api_response = api_instance.instagram_explore_get(cursor=cursor)
        print("The response of InstagramApi->instagram_explore_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InstagramApi->instagram_explore_get: %s\n" % e)

Parameters

Name Type Description Notes
cursor str [optional]

Return type

InstagramExploreGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

instagram_locations_id_get

InstagramLocationsIdGet200Response instagram_locations_id_get(id)

Get an Instagram location by id

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.instagram_locations_id_get200_response import InstagramLocationsIdGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.InstagramApi(api_client)
    id = 'id_example' # str | Numeric Instagram location id.

    try:
        # Get an Instagram location by id
        api_response = api_instance.instagram_locations_id_get(id)
        print("The response of InstagramApi->instagram_locations_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InstagramApi->instagram_locations_id_get: %s\n" % e)

Parameters

Name Type Description Notes
id str Numeric Instagram location id.

Return type

InstagramLocationsIdGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

instagram_locations_id_nearby_get

InstagramLocationsIdNearbyGet200Response instagram_locations_id_nearby_get(id)

List Instagram locations geographically near a given location

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.instagram_locations_id_nearby_get200_response import InstagramLocationsIdNearbyGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.InstagramApi(api_client)
    id = 'id_example' # str | 

    try:
        # List Instagram locations geographically near a given location
        api_response = api_instance.instagram_locations_id_nearby_get(id)
        print("The response of InstagramApi->instagram_locations_id_nearby_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InstagramApi->instagram_locations_id_nearby_get: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

InstagramLocationsIdNearbyGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

instagram_locations_id_posts_get

InstagramExploreGet200Response instagram_locations_id_posts_get(id, cursor=cursor, tab=tab)

List posts tagged with an Instagram location

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.instagram_explore_get200_response import InstagramExploreGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.InstagramApi(api_client)
    id = 'id_example' # str | 
    cursor = 'cursor_example' # str |  (optional)
    tab = 'tab_example' # str | Which tab to fetch — `ranked` (top) or `recent` (latest). (optional)

    try:
        # List posts tagged with an Instagram location
        api_response = api_instance.instagram_locations_id_posts_get(id, cursor=cursor, tab=tab)
        print("The response of InstagramApi->instagram_locations_id_posts_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InstagramApi->instagram_locations_id_posts_get: %s\n" % e)

Parameters

Name Type Description Notes
id str
cursor str [optional]
tab str Which tab to fetch — `ranked` (top) or `recent` (latest). [optional]

Return type

InstagramExploreGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

instagram_posts_shortcode_comments_comment_id_replies_get

InstagramPostsShortcodeCommentsCommentIdRepliesGet200Response instagram_posts_shortcode_comments_comment_id_replies_get(shortcode, comment_id, cursor=cursor)

List replies to an Instagram comment

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.instagram_posts_shortcode_comments_comment_id_replies_get200_response import InstagramPostsShortcodeCommentsCommentIdRepliesGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.InstagramApi(api_client)
    shortcode = 'shortcode_example' # str | 
    comment_id = 'comment_id_example' # str | 
    cursor = 'cursor_example' # str |  (optional)

    try:
        # List replies to an Instagram comment
        api_response = api_instance.instagram_posts_shortcode_comments_comment_id_replies_get(shortcode, comment_id, cursor=cursor)
        print("The response of InstagramApi->instagram_posts_shortcode_comments_comment_id_replies_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InstagramApi->instagram_posts_shortcode_comments_comment_id_replies_get: %s\n" % e)

Parameters

Name Type Description Notes
shortcode str
comment_id str
cursor str [optional]

Return type

InstagramPostsShortcodeCommentsCommentIdRepliesGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

instagram_posts_shortcode_comments_get

InstagramPostsShortcodeCommentsCommentIdRepliesGet200Response instagram_posts_shortcode_comments_get(shortcode, cursor=cursor, sort=sort)

List comments on an Instagram post

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.instagram_posts_shortcode_comments_comment_id_replies_get200_response import InstagramPostsShortcodeCommentsCommentIdRepliesGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.InstagramApi(api_client)
    shortcode = 'shortcode_example' # str | 
    cursor = 'cursor_example' # str |  (optional)
    sort = 'sort_example' # str |  (optional)

    try:
        # List comments on an Instagram post
        api_response = api_instance.instagram_posts_shortcode_comments_get(shortcode, cursor=cursor, sort=sort)
        print("The response of InstagramApi->instagram_posts_shortcode_comments_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InstagramApi->instagram_posts_shortcode_comments_get: %s\n" % e)

Parameters

Name Type Description Notes
shortcode str
cursor str [optional]
sort str [optional]

Return type

InstagramPostsShortcodeCommentsCommentIdRepliesGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

instagram_posts_shortcode_get

InstagramPostsShortcodeGet200Response instagram_posts_shortcode_get(shortcode)

Get an Instagram post (photo / video / carousel / reel) by shortcode

shortcode is the slug from the post URL, e.g. DUajw4YkorV in instagram.com/p/DUajw4YkorV/.

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.instagram_posts_shortcode_get200_response import InstagramPostsShortcodeGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.InstagramApi(api_client)
    shortcode = 'shortcode_example' # str | 

    try:
        # Get an Instagram post (photo / video / carousel / reel) by shortcode
        api_response = api_instance.instagram_posts_shortcode_get(shortcode)
        print("The response of InstagramApi->instagram_posts_shortcode_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InstagramApi->instagram_posts_shortcode_get: %s\n" % e)

Parameters

Name Type Description Notes
shortcode str

Return type

InstagramPostsShortcodeGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

instagram_reels_recommended_get

InstagramExploreGet200Response instagram_reels_recommended_get(cursor=cursor)

Browse Instagram's recommended Reels feed

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.instagram_explore_get200_response import InstagramExploreGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.InstagramApi(api_client)
    cursor = 'cursor_example' # str |  (optional)

    try:
        # Browse Instagram's recommended Reels feed
        api_response = api_instance.instagram_reels_recommended_get(cursor=cursor)
        print("The response of InstagramApi->instagram_reels_recommended_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InstagramApi->instagram_reels_recommended_get: %s\n" % e)

Parameters

Name Type Description Notes
cursor str [optional]

Return type

InstagramExploreGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

instagram_resolve_media_id_get

InstagramResolveMediaIdGet200Response instagram_resolve_media_id_get(shortcode)

Convert an Instagram post shortcode into its numeric media_id

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.instagram_resolve_media_id_get200_response import InstagramResolveMediaIdGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.InstagramApi(api_client)
    shortcode = 'shortcode_example' # str | 

    try:
        # Convert an Instagram post shortcode into its numeric media_id
        api_response = api_instance.instagram_resolve_media_id_get(shortcode)
        print("The response of InstagramApi->instagram_resolve_media_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InstagramApi->instagram_resolve_media_id_get: %s\n" % e)

Parameters

Name Type Description Notes
shortcode str

Return type

InstagramResolveMediaIdGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

instagram_resolve_shortcode_from_media_get

InstagramResolveMediaIdGet200Response instagram_resolve_shortcode_from_media_get(media_id)

Convert an Instagram numeric media_id into its shortcode

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.instagram_resolve_media_id_get200_response import InstagramResolveMediaIdGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.InstagramApi(api_client)
    media_id = 'media_id_example' # str | 

    try:
        # Convert an Instagram numeric media_id into its shortcode
        api_response = api_instance.instagram_resolve_shortcode_from_media_get(media_id)
        print("The response of InstagramApi->instagram_resolve_shortcode_from_media_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InstagramApi->instagram_resolve_shortcode_from_media_get: %s\n" % e)

Parameters

Name Type Description Notes
media_id str

Return type

InstagramResolveMediaIdGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

instagram_resolve_shortcode_get

InstagramResolveShortcodeGet200Response instagram_resolve_shortcode_get(url)

Extract a post shortcode from an Instagram URL

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.instagram_resolve_shortcode_get200_response import InstagramResolveShortcodeGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.InstagramApi(api_client)
    url = 'url_example' # str | 

    try:
        # Extract a post shortcode from an Instagram URL
        api_response = api_instance.instagram_resolve_shortcode_get(url)
        print("The response of InstagramApi->instagram_resolve_shortcode_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InstagramApi->instagram_resolve_shortcode_get: %s\n" % e)

Parameters

Name Type Description Notes
url str

Return type

InstagramResolveShortcodeGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

instagram_resolve_user_id_get

InstagramResolveUserIdGet200Response instagram_resolve_user_id_get(username)

Convert an Instagram username into its numeric user_id (pk)

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.instagram_resolve_user_id_get200_response import InstagramResolveUserIdGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.InstagramApi(api_client)
    username = 'username_example' # str | 

    try:
        # Convert an Instagram username into its numeric user_id (pk)
        api_response = api_instance.instagram_resolve_user_id_get(username)
        print("The response of InstagramApi->instagram_resolve_user_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InstagramApi->instagram_resolve_user_id_get: %s\n" % e)

Parameters

Name Type Description Notes
username str

Return type

InstagramResolveUserIdGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

instagram_search_get

InstagramExploreGet200Response instagram_search_get(q, cursor=cursor)

Cross-type Instagram search (posts/reels)

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.instagram_explore_get200_response import InstagramExploreGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.InstagramApi(api_client)
    q = 'q_example' # str | Search keyword.
    cursor = 'cursor_example' # str |  (optional)

    try:
        # Cross-type Instagram search (posts/reels)
        api_response = api_instance.instagram_search_get(q, cursor=cursor)
        print("The response of InstagramApi->instagram_search_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InstagramApi->instagram_search_get: %s\n" % e)

Parameters

Name Type Description Notes
q str Search keyword.
cursor str [optional]

Return type

InstagramExploreGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

instagram_users_username_followers_get

InstagramUsersUsernameFollowersGet200Response instagram_users_username_followers_get(username, cursor=cursor)

List followers of an Instagram user

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.instagram_users_username_followers_get200_response import InstagramUsersUsernameFollowersGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.InstagramApi(api_client)
    username = 'username_example' # str | 
    cursor = 'cursor_example' # str |  (optional)

    try:
        # List followers of an Instagram user
        api_response = api_instance.instagram_users_username_followers_get(username, cursor=cursor)
        print("The response of InstagramApi->instagram_users_username_followers_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InstagramApi->instagram_users_username_followers_get: %s\n" % e)

Parameters

Name Type Description Notes
username str
cursor str [optional]

Return type

InstagramUsersUsernameFollowersGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

instagram_users_username_following_get

InstagramUsersUsernameFollowersGet200Response instagram_users_username_following_get(username, cursor=cursor)

List accounts an Instagram user follows

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.instagram_users_username_followers_get200_response import InstagramUsersUsernameFollowersGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.InstagramApi(api_client)
    username = 'username_example' # str | 
    cursor = 'cursor_example' # str |  (optional)

    try:
        # List accounts an Instagram user follows
        api_response = api_instance.instagram_users_username_following_get(username, cursor=cursor)
        print("The response of InstagramApi->instagram_users_username_following_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InstagramApi->instagram_users_username_following_get: %s\n" % e)

Parameters

Name Type Description Notes
username str
cursor str [optional]

Return type

InstagramUsersUsernameFollowersGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

instagram_users_username_former_usernames_get

InstagramUsersUsernameFormerUsernamesGet200Response instagram_users_username_former_usernames_get(username)

List former usernames for an Instagram user

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.instagram_users_username_former_usernames_get200_response import InstagramUsersUsernameFormerUsernamesGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.InstagramApi(api_client)
    username = 'username_example' # str | 

    try:
        # List former usernames for an Instagram user
        api_response = api_instance.instagram_users_username_former_usernames_get(username)
        print("The response of InstagramApi->instagram_users_username_former_usernames_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InstagramApi->instagram_users_username_former_usernames_get: %s\n" % e)

Parameters

Name Type Description Notes
username str

Return type

InstagramUsersUsernameFormerUsernamesGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

instagram_users_username_get

InstagramUsersUsernameGet200Response instagram_users_username_get(username)

Get an Instagram user profile by username

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.instagram_users_username_get200_response import InstagramUsersUsernameGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.InstagramApi(api_client)
    username = 'username_example' # str | Instagram URL slug, e.g. `instagram`

    try:
        # Get an Instagram user profile by username
        api_response = api_instance.instagram_users_username_get(username)
        print("The response of InstagramApi->instagram_users_username_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InstagramApi->instagram_users_username_get: %s\n" % e)

Parameters

Name Type Description Notes
username str Instagram URL slug, e.g. `instagram`

Return type

InstagramUsersUsernameGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

instagram_users_username_highlights_get

InstagramUsersUsernameHighlightsGet200Response instagram_users_username_highlights_get(username, cursor=cursor)

List Instagram highlight reels for a user (metadata only)

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.instagram_users_username_highlights_get200_response import InstagramUsersUsernameHighlightsGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.InstagramApi(api_client)
    username = 'username_example' # str | 
    cursor = 'cursor_example' # str |  (optional)

    try:
        # List Instagram highlight reels for a user (metadata only)
        api_response = api_instance.instagram_users_username_highlights_get(username, cursor=cursor)
        print("The response of InstagramApi->instagram_users_username_highlights_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InstagramApi->instagram_users_username_highlights_get: %s\n" % e)

Parameters

Name Type Description Notes
username str
cursor str [optional]

Return type

InstagramUsersUsernameHighlightsGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

instagram_users_username_posts_get

InstagramExploreGet200Response instagram_users_username_posts_get(username, cursor=cursor)

List feed posts authored by an Instagram user

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.instagram_explore_get200_response import InstagramExploreGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.InstagramApi(api_client)
    username = 'username_example' # str | 
    cursor = 'cursor_example' # str |  (optional)

    try:
        # List feed posts authored by an Instagram user
        api_response = api_instance.instagram_users_username_posts_get(username, cursor=cursor)
        print("The response of InstagramApi->instagram_users_username_posts_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InstagramApi->instagram_users_username_posts_get: %s\n" % e)

Parameters

Name Type Description Notes
username str
cursor str [optional]

Return type

InstagramExploreGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

instagram_users_username_reels_get

InstagramExploreGet200Response instagram_users_username_reels_get(username, cursor=cursor)

List reels authored by an Instagram user

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.instagram_explore_get200_response import InstagramExploreGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.InstagramApi(api_client)
    username = 'username_example' # str | 
    cursor = 'cursor_example' # str |  (optional)

    try:
        # List reels authored by an Instagram user
        api_response = api_instance.instagram_users_username_reels_get(username, cursor=cursor)
        print("The response of InstagramApi->instagram_users_username_reels_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InstagramApi->instagram_users_username_reels_get: %s\n" % e)

Parameters

Name Type Description Notes
username str
cursor str [optional]

Return type

InstagramExploreGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

instagram_users_username_stories_get

InstagramExploreGet200Response instagram_users_username_stories_get(username)

List active Instagram stories for a user

Returns the user's currently-live story tray (empty when the user has no active stories).

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.instagram_explore_get200_response import InstagramExploreGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.InstagramApi(api_client)
    username = 'username_example' # str | 

    try:
        # List active Instagram stories for a user
        api_response = api_instance.instagram_users_username_stories_get(username)
        print("The response of InstagramApi->instagram_users_username_stories_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InstagramApi->instagram_users_username_stories_get: %s\n" % e)

Parameters

Name Type Description Notes
username str

Return type

InstagramExploreGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

instagram_users_username_tagged_posts_get

InstagramExploreGet200Response instagram_users_username_tagged_posts_get(username, cursor=cursor)

List posts an Instagram user is tagged in

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.instagram_explore_get200_response import InstagramExploreGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.InstagramApi(api_client)
    username = 'username_example' # str | 
    cursor = 'cursor_example' # str |  (optional)

    try:
        # List posts an Instagram user is tagged in
        api_response = api_instance.instagram_users_username_tagged_posts_get(username, cursor=cursor)
        print("The response of InstagramApi->instagram_users_username_tagged_posts_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InstagramApi->instagram_users_username_tagged_posts_get: %s\n" % e)

Parameters

Name Type Description Notes
username str
cursor str [optional]

Return type

InstagramExploreGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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