Skip to main content

Niilox Python SDK

Lightweight client — subset of the TypeScript @niilox/sdk. Same API base; not full module parity.

Install (PyPI):

pip install niilox

Monorepo contributors:

pip install -e .
from niilox import Client

client = Client.from_env()  # NIILOX_APP_ID, NIILOX_API_KEY
print(client.platform_ping())

client = Client("geogig", token=user_jwt)
print(client.users_me())

Covered methods

Area Methods
Platform platform_ping, platform_usage
SMS / numbers sms_*, numbers_*
Auth auth_guest, phone, password, refresh, forgot/reset
Users users_me, users_token_balance, users_confirm_age
Verification / profile verification_*, profile_*
Payments / wallet payments_identity_*, wallet_summary, payout_details
Gigs gigs_list, gigs_get, gigs_accept, gigs_video_call
DMs / peer dms_*, peer_ice, peer_signal_url
Rooms / seats rooms_*, seats_inventory, seats_reserve, seats_create_offering
Gifts gifts_list, gifts_send, gifts_my_gifters
Stage / moderation stage_get, stage_request, moderation_list, moderation_kick
Scheduled / rodent scheduled_*, rodent_create_booking
Safety safety_me
WebSockets ws_personal_url, ws_room_url

For full API coverage use TypeScript @niilox/sdk or client.request() via extending _HttpMixin.

See ../README.md and Platform status.

Download files

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

Source Distribution

niilox-0.1.0.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

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

niilox-0.1.0-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file niilox-0.1.0.tar.gz.

File metadata

  • Download URL: niilox-0.1.0.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for niilox-0.1.0.tar.gz
Algorithm Hash digest
SHA256 fbb41660a505f9446b29a3677bcb41c1af2d5f1f1a605f0a0c53df29b05b5dd5
MD5 21eb81a8e6e988dbe29df2a0643c785f
BLAKE2b-256 b86a00163da7ba92674b8cc67c0311bf9c25353f1615ac7aaac6264c493f23a9

See more details on using hashes here.

File details

Details for the file niilox-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: niilox-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for niilox-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2ac8f53f236872070d5f92b2d877fb77f46a9377174592ffdc4a2ea3ef527da2
MD5 e55fb050a6a3fb2f5fb7450d6f332968
BLAKE2b-256 d774ae08ece5eb112079f731be5eff973c43d6f9b3f832368efd4baf8d8fdf5d

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 files

Supported by

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