Metadata-Version: 2.1
Name: PanjSim
Version: 1.0.4
Summary: A simple Python API for 5sim.net
Home-page: https://github.com/abbas-bachari/PanjSim
Author: Abbas Bachari
Author-email: abbas-bachari@hotmail.com
License: MIT
Project-URL: Homepage, https://github.com/abbas-bachari/PanjSim
Project-URL: Documentation, https://github.com/abbas-bachari/PanjSim
Project-URL: Source, https://github.com/abbas-bachari/PanjSim/
Project-URL: Tracker, https://github.com/abbas-bachari/PanjSim/issues
Keywords: 5sim,5sim-sdk,5sim-pythom,PanjSim,virtual numbers,api,5sim-api,abbas bachari
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

[![PanjSim](https://img.shields.io/badge/PanjSim%20-Version%201.0.4-green?style=plastic&logo=codemagic)](https://python.org)
[![python](https://img.shields.io/badge/Python%20-3.7+-green?style=plastic&logo=Python)](https://python.org)




# What is PanjSim ? ([فارسی](https://github.com/abbas-bachari/PanjSim/blob/main/README-fa.md))
A simple Python API for [5sim.net](https://5sim.net)
#

# About [5sim.net](https://5sim.net)
Virtual numbers for receiving SMS and activation of any service

Upon registration on social networks, messengers, C2C platforms and on other websites, an SMS activation of account is required. 5SIM provides the opportunity to bypass verification procedure with the help of a temporary virtual phone number, without using the personal one. Register many profiles on websites, by receiving a confirmation code online.
#

## Installation guide
Before proceeding, you should register an account on [5sim.net](https://5sim.net/) and [generate a personal API key](https://5sim.net/settings/security) to use. 


#

Install from source:
``` bash
pip install git+https://github.com/abbas-bachari/PanjSim.git
```

Alternatively, install from [PyPI](https://pypi.org/project/PanjSim/):

```bash
# Install:
pip install PanjSim

# Update:
pip install -U PanjSim
```
<hr>

## user manual

###  Client 

```python
from PanjSim import PanjSim

# Replace your API key...
API_KEY = 'eyJhbGciOiJSUzUx.....' 

client = PanjSim(API_KEY) 
```
 

### Endpoints 
Official docs [here](https://docs.5sim.net/)
#


### Account Information

```python
from PanjSim import PanjSim

# Replace your API key...
API_KEY = 'eyJhbGciOiJSUzUx.....' 

client = PanjSim(API_KEY) 

user=client.User()

# Get account balance
balance=user.get_balance()


# Get Orders history
order_history=user.get_orders_history()


# Get payments history
pyment_history=user.get_payments_history()

```
#
### Price and products

```python
from PanjSim import PanjSim
from PanjSim.Countrys import usa

# Replace your API key...
API_KEY = 'eyJhbGciOiJSUzUx.....' 

client = PanjSim(API_KEY) 

country=usa


product=client.Products()

# Receive the name, the price, quantity of all products, available to buy.
operator=country.Operator.virtual23
product.get_products(country=country.name,operator=operator)


# Get all product prices
product.get_prices()

# Get product prices by country
product.get_prices(country=usa.name)

# Get product prices for a specific product
product.get_prices(product="telegram")

# Get product prices by country and specific product
product.get_prices(country=usa.name,product="telegram")

```
#
### Purchase

```python
from PanjSim import PanjSim
from PanjSim.Countrys import usa
# Replace your API key...
API_KEY = 'eyJhbGciOiJSUzUx.....' 

client = PanjSim(API_KEY) 

country=usa

Purchase=client.Purchase()


# Buy activation number
operator=country.Operator.virtual23
order=Purchase.buy_activation_number(country=country.name,operator=operator,product='telegram')

# Check order (Get SMS)
Purchase.check_order(order_id=order['id'])

# Ban order
Purchase.ban_order(order_id=order['id'])

# Cancel order
Purchase.cancel_order(order_id=order['id'])

# Finish order
Purchase.finish_order(order_id=order['id'])

# Get SMS inbox list
Purchase.get_sms_inbox(order_id=order['id'])

# Re-buy number
Purchase.rebuy_number(product="telegram",number='+177777')

# Buy hosting number
Purchase.buy_hosting_number(country=country.name,operator='any',product='1day')
```
#
### More features

```python
from PanjSim import PanjSim
from PanjSim.Countrys import usa

# Replace your API key...
API_KEY = 'eyJhbGciOiJSUzUx.....' 

client = PanjSim(API_KEY) 

# Get notifications
client.get_notification(lang='en')

# Get countries list
client.get_countries_list()

# Find the cheapest price
client.find_low_price(product='telegram',limit=5)
```
Powered by [Abbas Bachari](https://github.com/abbas-bachari).
