Skip to main content

A python Api wrapper of 5sim.net

Project description

FiveSimApi

A modern, easy to use, and async API wrapper for 5sim.net in Python.

Installation

Before proceeding, you should register an account on 5sim.net and generate a Api key to use.

pip install fivesimapi

Example Code

import FiveSimApi, asyncio
from FiveSimApi import fivesim

api_key = "....." # put your api key here

async def main():
    client = fivesim.FiveSim(api_key)
    data = await client.get_profile()
    print(data)

loop = asyncio.get_event_loop()
loop.run_until_complete(main())

User

# Provides profile data: email, balance and rating.
await client.get_profile()

# Provides orders history by choosen category.
await client.order_history(category)

# Provides payments history.
await client.payment_history()

Product and Prices

# To receive the name, the price, quantity of all products, available to buy.
await client.product_details(country, product)

# Returns product prices.
await client.get_prices()

# Returns product prices by country.
await client.get_prices_by_country(country)

# Returns product prices for a specific product.
await client.get_prices_by_product(product)

# Returns product prices by country and specific product.
await client.get_prices_by_country_and_product(country, product)

Purchase

# Buy activation number.
await client.buy_activation_number(country, operator, product)

# Buy hosting number.
await client.buy_hosting_number(country, operator, product)

# Buy again a old number.
await client.re_buy_number(product, number)

Order Management

# Check order history of a number by order's id..
await client.check_order(order_id)

# Get sms of a number by order's id.
await client.get_sms(order_id)

# Finish a order by order's id.
await client.finish_order(order_id)

# Cancel a order by order's id.
await client.cancel_order(order_id)

# Ban a order by order's id.
await client.ban_order(order_id)

# Provides sms inbox list by order's id.
await client.sms_inbox_list(order_id)

Notifications

# Get notifications.
await client.get_notifications(language)

Vendors

# Return Vendor statistics.
await client.vendor_stats()

# Available reserves currency for partner.
await client.wallets_reserve()

# Provides vendor's orders history by chosen category.
await client.vendor_orders_history(category)

# Provides vendor's payments history.
await client.vendor_payments_history()

# Create payouts for a partner.
await client.create_payouts(receiver, method, amount, fee)

Countries List

# Returns a list of countries with available operators for purchase.
await client.countries_list()

Others

# Return rates of cryptocurrencies.
await client.crypto_rates()

# Return address to crypto payment.
await client.get_deposit_address(amount, currency, address_type = None)

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

fivesimapi-0.2.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

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

fivesimapi-0.2-py3-none-any.whl (16.4 kB view details)

Uploaded Python 3

File details

Details for the file fivesimapi-0.2.tar.gz.

File metadata

  • Download URL: fivesimapi-0.2.tar.gz
  • Upload date:
  • Size: 16.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for fivesimapi-0.2.tar.gz
Algorithm Hash digest
SHA256 9a3e640e0401dc97c6d9f3d3317f443381214a339b81bfc715d199ebb35f653e
MD5 e40139c59bf8ab52d54a553edcda0263
BLAKE2b-256 c68ae2c2c95ab9732f145c99ddc485079d277b3a34a401651cd9145d88daef05

See more details on using hashes here.

File details

Details for the file fivesimapi-0.2-py3-none-any.whl.

File metadata

  • Download URL: fivesimapi-0.2-py3-none-any.whl
  • Upload date:
  • Size: 16.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for fivesimapi-0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 74421547245ea3911f4669180dca5fd465bc587790544befa026202dc23e370f
MD5 03323c3e02bc85b34d3c3eb6370735f4
BLAKE2b-256 622d4233087de7d9a95265476a6fbd413a8181c18c6f9a4c976719f8b5a3645e

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