Skip to main content

OST Kit API wrapper for Python

Project description

ost-kit-python

PyPI version

An unofficial OST Kit API wrapper for Python 2/3. Supports all functionality of OST Kit API v1.1.

Installation

pip install ost-kit-python

Usage

from ost_kit_python import OSTKit

# instantiate OST Kit with API credentials
ostkit = OSTKit(api_url='https://sandboxapi.ost.com/v1.1',
                api_key='OSTKIT_API_KEY',
                api_secret='OSTKIT_API_SECRET')

# execute API endpoint methods
r = ostkit.users.create('Jason')

# response JSON is automatically converted to a dictionary
user_id = r['data']['user']['id']

More Examples

# https://dev.ost.com/docs/api_users_create.html
r = ostkit.users.create(name='James')

# https://dev.ost.com/docs/api_users_edit.html
r = ostkit.users.update(user_id='abcd-1234-some-guid', name='Jimothy')

# https://dev.ost.com/docs/api_users_retrieve.html
r = ostkit.users.retrieve(user_id='abcd-1234-some-guid')

# https://dev.ost.com/docs/api_users_list.html
r = ostkit.users.list(limit=100)

# https://dev.ost.com/docs/api_airdrop_execute.html
r = ostkit.airdrops.execute(amount=6.66, user_ids=('abcd-1234-some-guid',))

# https://dev.ost.com/docs/api_airdrop_retrieve.html
r = ostkit.airdrops.retrieve(airdrop_id='abcd-1234-some-guid')

# https://dev.ost.com/docs/api_airdrop_list.html
r = ostkit.airdrops.list()

# https://dev.ost.com/docs/api_actions_create.html
r = ostkit.actions.create(name='Bonus',
                          kind='company_to_user',
                          amount=3.33,
                          arbitrary_amount='false')

# https://dev.ost.com/docs/api_actions_update.html
r = ostkit.actions.update(action_id=1234, name='MajorBonus')

# https://dev.ost.com/docs/api_actions_retrieve.html
r = ostkit.actions.retrieve(action_id=1234)

# https://dev.ost.com/docs/api_actions_list.html
r = ostkit.actions.list()

# https://dev.ost.com/docs/api_action_execute.html
r = ostkit.transactions.execute(from_user_id='abcd-1234-some-guid',
                                to_user_id='abcd-1234-some-guid',
                                action_id=1234)

# https://dev.ost.com/docs/api_transaction_retrieve.html
r = ostkit.transactions.retrieve(transaction_id='abcd-1234-some-guid')

# https://dev.ost.com/docs/api_transaction_list.html
r = ostkit.transactions.list()

# https://dev.ost.com/docs/api_balance.html
r = ostkit.balances.retrieve(user_id='abcd-1234-some-guid')

# https://dev.ost.com/docs/api_ledger.html
r = ostkit.ledger.retrieve(user_id='abcd-1234-some-guid')

# https://dev.ost.com/docs/api_transfers_create.html
r = ostkit.transfers.create(to_address='0x123456', amount=6.66)

# https://dev.ost.com/docs/api_transfers_retrieve.html
r = ostkit.transfers.retrieve(transfer_id='abcd-1234-some-guid')

# https://dev.ost.com/docs/api_transfers_list.html
r = ostkit.transfers.list()

# https://dev.ost.com/docs/api_token.html
r = ostkit.token.retrieve()

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

ost-kit-python-0.0.4.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

ost_kit_python-0.0.4-py2-none-any.whl (4.3 kB view details)

Uploaded Python 2

File details

Details for the file ost-kit-python-0.0.4.tar.gz.

File metadata

  • Download URL: ost-kit-python-0.0.4.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/2.7.10

File hashes

Hashes for ost-kit-python-0.0.4.tar.gz
Algorithm Hash digest
SHA256 7324a4b160ff95509d30bf15f8bba48236fe68030d08774e2583034a380f352e
MD5 af4c37697cf95b67f92dbd003e38f37f
BLAKE2b-256 034769d2e4d61aa6431669b768bfa09cd70be41be18a0b13a4523139b5484d12

See more details on using hashes here.

File details

Details for the file ost_kit_python-0.0.4-py2-none-any.whl.

File metadata

  • Download URL: ost_kit_python-0.0.4-py2-none-any.whl
  • Upload date:
  • Size: 4.3 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/2.7.10

File hashes

Hashes for ost_kit_python-0.0.4-py2-none-any.whl
Algorithm Hash digest
SHA256 45fa1f8679724928ad429ed609404dcf240b8954a2ab510d7aefaefd0ad9a2da
MD5 15cbc0c316d431bed584c8b36a898100
BLAKE2b-256 5f9a132b1400430caaac11816e86a3e0822c042e556a96641a322baa636e0f26

See more details on using hashes here.

Supported by

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