Skip to content
LogoLogo

Actions

Every action exists both as a client method and as a function taking the client:

from arrekta_sdk import Client, get_utxos
 
client = Client("http://127.0.0.1:28332")
coins = client.get_utxos(address="rarrk1p…")
coins = get_utxos(client, address="rarrk1p…")      # same call

With AsyncClient, the same methods are coroutines. Response fields are documented in the REST API reference.

ActionRoute
get_chain()GET /v1/chain
get_block(id=…)GET /v1/blocks/{id}
get_deployments()GET /v1/deployments
get_checkpoints() / submit_checkpoint(hex=…)GET / POST /v1/checkpoints
get_transaction(txid=…) / get_raw_transaction(txid=…)GET /v1/txs/{txid} (/raw)
decode_transaction(hex=…)POST /v1/txs/decode
send_transaction(tx=… or hex=…)POST /v1/txs
send_package(parent=…, child=…)POST /v1/txs/package
get_address(address=…)GET /v1/addresses/{address}
get_utxos(address=…, asset=None)GET /v1/addresses/{address}/utxos
get_address_history(address=…)GET /v1/addresses/{address}/txs
get_assets() / get_asset(id_or_ticker=…)GET /v1/assets (/{key})
get_frozen(asset=…)GET /v1/assets/{key}/frozen
get_mempool() / estimate_fee()GET /v1/mempool, GET /v1/fees
get_mining_template(address=…)GET /v1/mining/template
create_aux_block(address=…) / submit_aux_block(hash=…, auxpow=…)POST /rpc
get_block_filter(id=…) / get_filter_headers(start=…, count=…)light-client routes

Events

for event in client.watch_events():
    print(event["type"], event["id"])

watch_events(last_event_id=…) resumes after a given event on the node stream (last 1,000 events; a stream.reset event means resync via REST) and on the gateway stream; the async client yields events with async for. Full example: Watch events.