Skip to main content

Python SDK for MangroveMarkets — DEX aggregation, wallet management, and portfolio analytics for agents

Project description

mangrovemarkets

PyPI Downloads

Python SDK for MangroveMarkets -- DEX aggregation, wallet management, and portfolio analytics for agents.

Installation

pip install mangrovemarkets

The package imports as mangrove_markets (e.g. from mangrove_markets import MangroveMarkets). The legacy import mangrovemarkets path also still works for backwards compatibility.

Quickstart

The MangroveMarkets MCP server requires an API key for authenticated endpoints. You can pass it explicitly via the api_key parameter or set the MANGROVE_API_KEY environment variable (the SDK reads it automatically as a fallback).

import os
from mangrove_markets import MangroveMarkets

client = MangroveMarkets(
    base_url="https://mangrovemarkets-pcqgpciucq-uc.a.run.app",
    api_key="prod_...",  # or rely on MANGROVE_API_KEY env var
)

# Chain info
info = client.wallet.chain_info(chain="evm")
print(f"Chain: {info.chain}, Native token: {info.native_token}")

# DEX venues
venues = client.dex.supported_venues()
for v in venues:
    print(f"  {v.id}: {v.name} ({v.chain}) - {v.supported_pairs_count} pairs")

# Portfolio value
value = client.portfolio.value(addresses="0xYOUR_WALLET_ADDRESS")
print(f"Total portfolio: ${value.total_value_usd:,.2f}")

client.close()

The client also works as a context manager (and picks up MANGROVE_API_KEY / MANGROVE_BASE_URL from the environment):

with MangroveMarkets() as client:
    venues = client.dex.supported_venues()

For local development, point the client at a locally running MCP server:

client = MangroveMarkets(base_url="http://localhost:8080", api_key=os.getenv("MANGROVE_API_KEY"))

Getting an API key

  1. Sign up at https://mangrovedeveloper.ai.

  2. Go to Settings -> API Keys -> Create.

  3. Copy the key -- it is shown only once.

  4. Export it as MANGROVE_API_KEY or pass it directly to MangroveMarkets(api_key=...):

    export MANGROVE_API_KEY="prod_..."
    

If you call the API without a valid key, the server returns HTTP 401 with this payload:

{"detail": "Missing or malformed Authorization header. Expected: Bearer <api_key>"}

Full swap flow

A DEX swap goes through six steps: quote, approve, prepare, sign locally, broadcast, and confirm.

import os
from mangrove_markets import MangroveMarkets

client = MangroveMarkets(
    base_url="https://mangrovemarkets-pcqgpciucq-uc.a.run.app",
    api_key=os.getenv("MANGROVE_API_KEY"),
)

# 1. Get a quote
quote = client.dex.get_quote(
    input_token="0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",  # USDC on Base
    output_token="0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",  # ETH
    amount=1_000_000,  # 1 USDC (6 decimals)
    chain_id=8453,
)
print(f"Quote: {quote.input_amount} -> {quote.output_amount} (rate: {quote.exchange_rate})")

# 2. Approve token spending (ERC-20 only, returns None if already approved)
approval = client.dex.approve_token(
    token_address="0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
    chain_id=8453,
    wallet_address="0xYOUR_WALLET",
)
if approval:
    # Sign the approval tx with your local signer, then broadcast
    # signed_approval = your_signer.sign(approval.payload)
    # client.dex.broadcast(signed_tx=signed_approval, chain_id=8453)
    pass

# 3. Prepare the swap transaction
swap_tx = client.dex.prepare_swap(
    quote_id=quote.quote_id,
    wallet_address="0xYOUR_WALLET",
)

# 4. Sign locally (SDK never touches private keys)
# signed_swap = your_signer.sign(swap_tx.payload)

# 5. Broadcast
# result = client.dex.broadcast(signed_tx=signed_swap, chain_id=8453)

# 6. Confirm
# status = client.dex.tx_status(tx_hash=result.tx_hash, chain_id=8453)

client.close()

Configuration

Parameter Env var Default Description
base_url MANGROVE_BASE_URL https://mangrovemarkets-pcqgpciucq-uc.a.run.app MCP server URL (use http://localhost:8080 for local dev)
api_key MANGROVE_API_KEY None API key for authenticated endpoints
timeout -- 30.0 Request timeout in seconds
max_retries -- 3 Max retries on 429/5xx
auto_retry -- True Enable automatic retry with backoff

Examples

See the examples/ directory for runnable scripts:

  • quickstart.py -- chain info and DEX venues
  • swap_flow.py -- full swap lifecycle
  • portfolio_check.py -- portfolio value, P&L, and token holdings
  • e2e_swap.py -- a real 0.1 USDC → ETH swap on Base mainnet (requires web3 and a funded wallet; install with pip install mangrovemarkets[e2e] or pip install web3)

Run the end-to-end swap with:

E2E_SWAP_PRIVATE_KEY=0x... MANGROVE_API_KEY=prod_... python examples/e2e_swap.py

Costs a few cents in gas per run. Never runs in CI.

Security

The SDK never stores or transmits private keys. All signing happens locally in your application. The prepare_swap and approve_token methods return unsigned transaction payloads that you sign with your own wallet/signer before broadcasting through broadcast.

API reference

This SDK wraps the MangroveMarkets MCP Server REST API. For full tool documentation, parameter details, and response schemas, see the MangroveMarkets-MCP-Server repository.

License

MIT

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

mangrovemarkets-1.0.3.tar.gz (26.4 kB view details)

Uploaded Source

Built Distribution

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

mangrovemarkets-1.0.3-py3-none-any.whl (22.4 kB view details)

Uploaded Python 3

File details

Details for the file mangrovemarkets-1.0.3.tar.gz.

File metadata

  • Download URL: mangrovemarkets-1.0.3.tar.gz
  • Upload date:
  • Size: 26.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mangrovemarkets-1.0.3.tar.gz
Algorithm Hash digest
SHA256 9e83adc57cbb813ceebc14250bce2be7f7055feabf97ee6a49b1dd51696dcd6e
MD5 c1de7a4e61462d1474a9774233e45e08
BLAKE2b-256 74f5b130caf410b39ca0bda23b7176eddc278246b18268643cada7fea615bc6a

See more details on using hashes here.

File details

Details for the file mangrovemarkets-1.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for mangrovemarkets-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 14b3b7e4e57b33a609725d979fdc251c6b53042043ebda8a9eb7b1a0f4bbaf31
MD5 909559e77a6ecb866bd6e911273ee977
BLAKE2b-256 0add3fc4a45a3ef47bd20230205de032608f8f50f76ca3f51ecb948101a7c077

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