https://github.com/amirhoseinsalimi/boxapi-python
Python client for https://boxapi.ir to crawl and read Instagram data.
https://github.com/amirhoseinsalimi/boxapi-python
crawler instagram instagram-api python python3
Last synced: 27 days ago
JSON representation
Python client for https://boxapi.ir to crawl and read Instagram data.
- Host: GitHub
- URL: https://github.com/amirhoseinsalimi/boxapi-python
- Owner: amirhoseinsalimi
- License: mit
- Created: 2025-03-07T12:26:25.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-31T20:07:41.000Z (about 1 year ago)
- Last Synced: 2026-03-07T09:41:04.346Z (4 months ago)
- Topics: crawler, instagram, instagram-api, python, python3
- Language: Python
- Homepage:
- Size: 33.2 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BoxAPI Python
A Python client for interacting with the [Box API](https://boxapi.ir) for Instagram. This library wraps multiple Instagram endpoints including user information, media retrieval, and direct messages, allowing you to easily integrate Instagram functionality into your Python applications.
> **Note**
> I have not been able to test the DM API. Please make sure to test your implementation thoroughly before using it in
> production. If you encounter any issues, feel free to open an issue or submit a pull request.
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Project Structure](#project-structure)
- [Usage](#usage)
- [General Instagram API](#general-instagram-api)
- [Direct Messages](#direct-messages)
- [Examples](#examples)
- [Contributing](#contributing)
- [License](#license)
## Features
- **Modular Design**: Separate sub-clients for general Instagram endpoints and direct message (DM) endpoints.
- **Easy Integration**: Instantiate a single client to access the full functionality of the Box API.
- **Flexible Usage**: Use DM endpoints only when needed—save overhead if your application doesn’t require them.
- **Extensible**: Add additional endpoints or support for other platforms with minimal changes.
## Installation
You can install the package via [pip](https://pypi.org/project/pip/) or [Poetry](https://python-poetry.org/).
### Using pip
```bash
pip install boxapi
```
### Using Poetry
```bash
poetry add boxapi
```
## Usage
### General Instagram API
```python
from boxapi import BoxApiClient
# Initialize BoxApiClient with Box API credentials
# IMPORTANT: MAKE SURE YOU ARE READING YOUR USERNAME AND PASSWORD FROM ENVIRONMENT VARIABLES
box_client = BoxApiClient("your_boxapi_username", "your_boxapi_password")
# Use the Instagram sub-client for general endpoints
user_info = box_client.instagram.get_user_info("leomessi")
print(user_info)
```
### Direct Messages
Direct Message functionality is available through a separate sub-client. Instantiate it when needed:
```python
from boxapi import BoxApiClient
# Initialize BoxApiClient with Box API credentials
box_client = BoxApiClient("your_boxapi_username", "your_boxapi_password")
# Use DM endpoints by providing the Instagram account credentials per call
login_response = box_client.instagram_dm.direct_login("insta_username", "insta_password")
print(login_response)
```
## Examples
Check out the [examples](./examples) folder for complete scripts demonstrating how to use the different features of this library (It's a work in progress).
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.