Skip to main content

Instagram official api 2.0 client by robosell.uz

Project description

Instagram API Client Library

A Python library for interacting with the official Instagram Graph API. This client provides easy-to-use methods for authentication, user management, conversations, and messaging functionality.

Official instagram documentation

Demo

You can visit robosell to test how instagram integration works and features have

Features

  • OAuth 2.0 Authentication
  • Long-lived token exchange
  • User profile management
  • Conversation handling
  • Message management
  • Built-in pagination support

Installation

pip install instagram-client

Prerequisites

Before using this library, you need to:

  1. Create an Instagram App in the Meta for Developers Console
  2. Obtain your Client ID and Client Secret
  3. Configure your OAuth redirect URI
  4. Set up the required scopes for your application

Quick Start

from instagram_client import InstagramClient


# Initialize the client
client = InstagramClient(
    client_id="your_client_id",
    client_secret="your_client_secret",
    redirect_uri="your_redirect_uri",
    scopes=["instagram_business_basic", "instagram_business_manage_messages"]
)
# For more detailed information visit https://developers.facebook.com/docs/instagram-platform/instagram-api-with-instagram-login

# Get the authorization URL
auth_url = client.get_auth_url()

# Also you can pass custom data to oauth url:
# auth_url = client.get_auth_url(state="user_{user_id}")

# Redirect user to auth_url for authorization

# After user authorization, exchange the code for an access token
login_response = client.retrieve_access_token(code="authorization_code")

# Exchange for a long-lived token
long_lived_token = client.exchange_long_lived_token() # long lived token expires in 60 days and short token expires in 30min

# Get authenticated user's profile
user_profile = client.get_me()

Detailed Usage

Authentication Flow

# Create new endpoint to redirect oauth url

# 1. Generate authentication URL
auth_url = client.get_auth_url(
    enable_fb_login=1,
    force_authentication=0,
    state="optional_state_parameter"
)

# 2. After user authorization, exchange the code for an access token
login_response = client.retrieve_access_token(code="authorization_code")
print(f"Access Token: {login_response.access_token}")

# 3. Exchange for a long-lived token
long_lived_token = client.exchange_long_lived_token()
print(f"Long-lived Token: {long_lived_token.access_token}")
print(f"Token Expires in: {long_lived_token.expires_in} seconds")

User Management

# Get authenticated user's profile
me = client.get_me()
print(f"Username: {me.username}")
print(f"Followers: {me.followers_count}")
print(f"Following: {me.follows_count}")

# Get another user's profile
user_profile = client.get_profile_info(user_id="target_user_id")
print(f"Name: {user_profile.name}")
print(f"Is Following Business: {user_profile.is_user_follow_business}")

Conversation Management

# Get all conversations
conversations = client.get_conversations()
for conversation in conversations:
    print(f"Conversation ID: {conversation.id}")
    print(f"Participants: {conversation.participants}")

# Get conversation with specific user
user_conversations = client.get_user_conversation(
    user_id="target_user_id")

# Get messages from a conversation
messages = client.get_conversation_messages(
    conversation_id="conversation_id",
    desired_limit=100  # Optional: limit number of messages
)

for message in messages:
    print(f"From: {message.from_}")
    print(f"Message: {message.message}")
    print(f"Time: {message.created_time}")

Sending Messages

from instagram_client.schemes.conversation_schemes import SendMessageScheme

# Create message payload
message = SendMessageScheme(
    message="Hello from Instagram API Client!",
    recipient_id="target_user_id"
)

# Send message
response = client.send_message(
    instagram_id="target_user_id",
    payload=message
)

Error Handling

The library includes built-in error handling for common API issues:

from instagram_client.exceptions.http_exceptions import ForbiddenApiException

try:
    token = client.retrieve_access_token(code="invalid_code")
except ForbiddenApiException as e:
    print(f"Authentication failed: {e}")

API Documentation

For detailed information about the Instagram Graph API endpoints and features, visit the official Instagram Graph API documentation.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Security

Please note that this library handles sensitive authentication tokens. Always follow security best practices:

  • Never commit tokens to version control
  • Store sensitive credentials in environment variables
  • Use secure methods to handle and store access tokens
  • Implement proper token refresh mechanisms

Support

If you encounter any issues or have questions, please file an issue on the GitHub repository.

Contacts:

Email - erkinovabdulvoris101@gmail.com

Telegram - @abdulvoris_101

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

instagram_client-0.2.2.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

instagram_client-0.2.2-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

Details for the file instagram_client-0.2.2.tar.gz.

File metadata

  • Download URL: instagram_client-0.2.2.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for instagram_client-0.2.2.tar.gz
Algorithm Hash digest
SHA256 ccb6b67d8e61874c632973dc3cdfc2056f938ec120ab72622b0f16bcb4444a9e
MD5 69204cb3d80e5ea1296c9443b8a04baf
BLAKE2b-256 5c4b9113f665ceab827619e9fd15882098c6b4b9b0a898fa56f4f3b111a29556

See more details on using hashes here.

File details

Details for the file instagram_client-0.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for instagram_client-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 58cf4e2544c74b8032f81dd50c0f0883355aea761efda1e601d9e5b1643d81cd
MD5 29d5939073de7a941272918188f0bf5a
BLAKE2b-256 1ab4d1b6b1265968e7e076a9226d0dad447c5f1dd2a99a6748e50930c844ce65

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page