Skip to main content

bluapi

Python client for the Blu Bank HTTP API.

The bank's own gateway speaks protobuf over HTTP/2 and only answers from an Iranian IP, so the protocol is handled by the companion blu-api server. This package is a thin, typed client for that server.

pip install bluapi

Use

Start the server first (see the blu-api README), then:

import bluapi

with bluapi.Client() as blu:
    print(blu.balance()["total"])
    print(blu.owner("6104335551234567"))

Client defaults to http://127.0.0.1:8088, or $BLU_API_URL when set. Pass api_key= (or set $BLU_API_KEY) if the server was started with BLU_API_KEY.

Session

blu.login("username", "password")   # otpRequired: true on a fresh device
blu.otp("123456")                   # only then
blu.logout()

A device the bank has already trusted logs in without a code, and the server renews the token silently, so in practice you log in once.

Money

blu.transfer(1000, "6104335551234567")             # card to card
blu.transfer(1000, "IR000560611828001111111101", method=bluapi.PAYA)

Amounts are IRR. Source and destination must differ, so the account's own Blu card cannot be the destination. This moves real money.

Card payments

blu.card_otp("6219865551234568")
# {'code': '123456', 'otpRequest': '73443', 'validFrom': ..., 'expiresIn': 120, ...}

The dynamic second password a card payment asks for: six digits, single use, valid for about two minutes. Fetch it right before paying.

Finding a transaction

blu.find_transaction("249042")
# {'receipt': '249042', 'type': 'انتقال به کارت', 'amount': '۱۰٬۰۰۰ ریال', ...}

Every receipt carries a کد پیگیری. There is no lookup by it, so the server walks the history page by page; pages= bounds how far back it goes.

Everything else

blu.status()            blu.profile()          blu.balances()
blu.cards()             blu.all_cards()        blu.transactions()
blu.card_otp(card)      # رمز دوم پویا, valid ~2 minutes
blu.find_transaction("249042")  # by receipt number, walks the history
blu.recent_transfers()  blu.scheduled_transfers()
blu.banks()             blu.contacts()         blu.cheques()
blu.cashback_categories()                      blu.cashback_vendors()
blu.recent_charges()    blu.recent_internet_packages()
blu.favorite_bills()    blu.banners()          blu.onboarding()
blu.junior()            blu.identities()       blu.processed_cards()
blu.transfer_get(id)    blu.transfer_cancel(id)

Responses are the server's JSON. Gateway payloads are protobuf on the wire and arrive as nested dicts keyed by field number.

Raw routes

blu.raw(
    "account/deposit/list/all",
    "solutions.saman.bluebank.services.AccountListAllRequest",
    "solutions.saman.bluebank.services.AccountListAllResponse",
)

Errors

ApiError carries status and payload. GatewayError is a subclass raised when the bank itself rejected the call, and carries detail. Both derive from BluApiError.

try:
    blu.owner("0000000000000000")
except bluapi.GatewayError as exc:
    print(exc.status, exc.detail)

Command line

bluapi status
bluapi balance
bluapi call owner 6104335551234567

Notes

  • Python 3.8+, standard library only.
  • The server is single-account: whichever session is active answers.
  • transfer_get and transfer_cancel only resolve ids from the two-step transfer/init + submit flow, so an id from transfer() usually answers 404 or 500.

License

MIT.

Metadata

Release files for bluapi 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bluapi 0.3.0
File Size Uploaded Provenance Actions
bluapi-0.3.0.tar.gz 9.5 kB Without provenance Details for bluapi-0.3.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for bluapi 0.3.0
File Interpreter ABI Platform Actions
bluapi-0.3.0-py3-none-any.whl Python 3 none any Details for bluapi-0.3.0-py3-none-any.whl

Total release size: 21.5 kB

Release files / bluapi-0.3.0.tar.gz

Download URL bluapi-0.3.0.tar.gz
Size 9.5 kB
Tags Source
SHA-256 checksum
How to use checksums
69c04b7cfce29c07e7611b7700f26819c037c90ffd9edb80ae86bf63bc0b0c59
BLAKE2b-256 checksum
How to use checksums
1b00291b21e77adeb626444dc5590565535f9f497f7749ea527aa5fe8575cace
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.12

Release files / bluapi-0.3.0-py3-none-any.whl

Download URL bluapi-0.3.0-py3-none-any.whl
Size 12.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
886c83cd08b170498c033a45632863ef208a91a62621013135f264ff97d19db2
BLAKE2b-256 checksum
How to use checksums
c55ea7e45713a9f754f088c383847b4a723b9f334467bcb5a20d841f3cc62f02
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.12

Security for bluapi 0.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page