Skip to main content

Quick Start

Use the Alchemy provider plugin to interact with blockchains via APIs. The ape-alchemy plugin supports the following ecosystems:

  • Abstract
  • ApeChain
  • Arbitrum
  • Astar
  • Avalanche
  • Base
  • Berachain
  • Blast
  • BSC (including opBNB)
  • CrossFi
  • Ethereum
  • Fantom
  • Flow EVM
  • Gnosis
  • Lens
  • Linea
  • Lumia
  • Mantle
  • Metis
  • Optimism
  • Polygon
  • Polygon-ZkEVM
  • Rootstock
  • Scroll
  • Shape
  • Soneium
  • Sonic
  • Unichain
  • XMTP
  • World-Chain
  • zetachain
  • ZkSync
  • Zora

Dependencies

Installation

via pip

You can install the latest release via pip:

pip install ape-alchemy

via setuptools

You can clone the repository and use setuptools for the most up-to-date version:

git clone https://github.com/ApeWorX/ape-alchemy.git
cd ape-alchemy
python3 setup.py install

Quick Usage

First, make sure you have one of the following environment variables set (it doesn't matter which one):

  • WEB3_ALCHEMY_PROJECT_ID
  • WEB3_ALCHEMY_API_KEY
  • WEB3_<ecosystem>_<network>_ALCHEMY_PROJECT_ID
  • WEB3_<ecosystem>_<network>_ALCHEMY_PROJECT_ID

For example, to use both Arbitrum and Ethereum in the same session, you could set both WEB3_ARBITRUM_MAINNET_ALCHEMY_PROJECT_ID and WEB3_ETHEREUM_MAINNET_ALCHEMY_PROJECT_ID.

NOTE: If using non-Ethereum networks, take care to install the correct plugins, such as ape-arbitrum, ape-optimism, etc:

ape plugins install arbitrum

Then, either in your current terminal session or in your root RC file (e.g. .bashrc), add the following:

export WEB3_ALCHEMY_PROJECT_ID=MY_API_TOKEN=<value-of-secret-key>

To use the Alchemy provider plugin in most commands, set it via the --network option:

ape console --network ethereum:sepolia:alchemy

To connect to Alchemy from a Python script, use the networks top-level manager:

from ape import networks

with networks.parse_network_choice("ethereum:mainnet:alchemy") as provider:
    ...

Transaction Traces

If you are using a paid tier of Alchemy, you have access to both Geth and Parity style traces. Parity traces are faster and thus are the ones uses in Ethereum receipts' show_trace() method:

from ape import networks

alchemy = networks.provider  # Assuming connected to Alchemy
txn_hash = "0x053cba5c12172654d894f66d5670bab6215517a94189a9ffc09bc40a589ec04d"
receipt = alchemy.get_transaction(txn_hash)
receipt.show_trace()  # Prints the Transaction trace

To access the raw CallTree, do:

from ape import networks

alchemy = networks.provider  # Assuming connected to Alchemy
txn_hash = "0x053cba5c12172654d894f66d5670bab6215517a94189a9ffc09bc40a589ec04d"
call_tree = alchemy.get_call_tree(txn_hash)

To learn more about transaction traces, view Ape's transaction guide.

Metadata

Release files for ape-alchemy 0.8.11

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

Source distribution (sdist)

Source distribution for ape-alchemy 0.8.11
File Size Uploaded
ape_alchemy-0.8.11.tar.gz 28.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ape-alchemy 0.8.11
File Interpreter ABI Platform
ape_alchemy-0.8.11-py3-none-any.whl Python 3 none any Details

Total release size: 44.9 kB

Release files / ape_alchemy-0.8.11.tar.gz

Download URL ape_alchemy-0.8.11.tar.gz
Size 28.7 kB
Tags Source
SHA-256 checksum
How to use checksums
6c566afefd0e9491b56d4213fc2774d33d4f1dbf97b4f4c9a3cecfe8e262fa4f
BLAKE2b-256 checksum
How to use checksums
30846b075190cfb98b80373cea4a47404ffa61e0dc63e49c32ff5a7eab3efd32
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Feb 2, 2026.

Transparency log

Release files / ape_alchemy-0.8.11-py3-none-any.whl

Download URL ape_alchemy-0.8.11-py3-none-any.whl
Size 16.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4028deb2206d3d6ba539b9077af7e5542e3808d57877a52065ac96452387be5e
BLAKE2b-256 checksum
How to use checksums
764c7b6e07b64638dfd40bf452a59ad7c6f819a79ff5fc0c2fb3e5aa495c1cf0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Feb 2, 2026.

Transparency log
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