Skip to main content

A lightweight library that works as a connector to the Flare explorer api

Project description

Flare explorer python

Package version Linting and tests codecov Supported Python versions Code Style License: MIT

A lightweight library that works as a connector to the Flare explorer api

If you came here looking for the flare network, then go here. If you want to query flares blockchain using python then stick around.

Installation

flare-explorer-python is available on PYPI. Install with pip or poetry:

pip install flare-explorer-python
poetry add flare-explorer-python

Usage

Transactions

from flare_explorer.transaction import (
    get_internal_transactions,
    get_transaction,
    get_transactions_from_address,
)

transaction = get_transaction("transaction_hash")

internal_transactions, page_info = get_internal_transactions(
    "transaction_hash",
    previous_cursor="previous_page_last_cursor"
)

transactions, page_info = get_transactions_from_address(
    "address_hash",
    previous_cursor="previous_page_last_cursor"
)

Addresses

from flare_explorer.address import get_address, get_addresses

address = get_address(
    "address_hash",
)

addresses = get_addresses(
    [
        "address_hash_1",
        "address_hash_2",
    ]
)

Blocks

from flare_explorer.block import get_block

block = get_block(4463469)

Token transfers

from flare_explorer.token_transfers import get_token_transfers

token_transfers, page_info = get_token_transfers(
    "token_contract_address_hash",
    previous_cursor="previous_page_last_cursor"
)

Upcoming features

  • asyncio support
  • websocket support
  • fast mode (no pydantic serialization)

Testing / Contributing

Any contributions or issue raising is welcomed. If you wish to contribute then:

  1. fork/clone this repo
  2. make changes on a branch taken from main
  3. submit a pull request against main

Pull requests will be blocked from merging automatically if:

  • less than 100% coverage
  • there are failing tests
  • linting rules have been violated.

Publishing new package version

  1. Bump version number in pyproject.toml
  2. Commit the version bump
  3. Create a new release on github
  4. poetry build
  5. poetry publish

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

flare_explorer_python-1.0.0.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

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

flare_explorer_python-1.0.0-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

Details for the file flare_explorer_python-1.0.0.tar.gz.

File metadata

  • Download URL: flare_explorer_python-1.0.0.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.11 Darwin/24.5.0

File hashes

Hashes for flare_explorer_python-1.0.0.tar.gz
Algorithm Hash digest
SHA256 39ee5022202bad3195146617797184e1158a806153d356762266670fb2ad924e
MD5 6b393e9bb6be0fee83e14cecbd465cd8
BLAKE2b-256 b92a0c45365a1067e2beeb5a809f0cce7897402ae8efbfbc02fe0f4ef11ad91c

See more details on using hashes here.

File details

Details for the file flare_explorer_python-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for flare_explorer_python-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 598b2cceef873948ade161a7fa4723d86b1058dd890b6ec1ebb40c4e622cfbf8
MD5 b8014d842c370398998f0cb01ca14c80
BLAKE2b-256 8d4177afba536b5e7dce08ee4b28773227936750dee552ba1b840648e60f3d9e

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