Skip to content

API Reference

Bismuth exposes 11 MCP tools. No API key required — every call is a USDC micropayment on Base. All tools include a free test endpoint to try without a wallet.


List all APIs in the Bismuth network with pricing, status, and capabilities.

Cost: Free — no payment required.

No parameters.

Returns: Network info, wallet status (whether X402_PRIVATE_KEY is set), and a list of all APIs with their health status, price, and description.

Example:

“What APIs are available on Bismuth?“

{
"tool": "x402_network_info"
}

Capture a screenshot of any URL and return it as a base64-encoded image.

Free test endpoint: GET /screenshot/test — returns fixture data, no wallet required. Paid endpoint: POST /screenshot — $0.01 USDC on Base per call.

ParameterTypeRequiredDefaultDescription
urlstringYesFull URL to capture (must include https://)
widthintegerNo1280Viewport width in pixels (320–3840)
heightintegerNo720Viewport height in pixels (240–2160)
full_pagebooleanNofalseCapture the full scrollable page
formatstringNo"png"Image format: png, jpeg, or webp

Returns: Base64-encoded image data in the specified format.

Example:

“Take a screenshot of stripe.com’s pricing page at 1440px wide”

{
"tool": "x402_screenshot",
"arguments": {
"url": "https://stripe.com/pricing",
"width": 1440,
"height": 900
}
}

Extract text content from a PDF document via URL.

Free test endpoint: GET /pdf/test — returns fixture data, no wallet required. Paid endpoint: POST /pdf — $0.01 USDC on Base per call.

ParameterTypeRequiredDefaultDescription
pdf_urlstringYesFull URL of the PDF to extract text from

Returns: Extracted text content, page count, and document metadata.

Example:

“Extract the text from this SEC filing PDF: https://example.com/filing.pdf

{
"tool": "x402_pdf_extract",
"arguments": {
"pdf_url": "https://example.com/annual-report.pdf"
}
}

Get real-time crypto sentiment analysis for a specific coin.

Free test endpoint: GET /sentiment/test — returns fixture data, no wallet required. Paid endpoint: POST /sentiment — $0.01 USDC on Base per call.

ParameterTypeRequiredDefaultDescription
coinstringYesCryptocurrency ticker symbol (e.g., BTC, ETH, SOL) — 1–10 alphanumeric characters

Returns: Sentiment score (−1 to 1), confidence level, data sources, and analysis summary.

Example:

“What’s the current sentiment for Ethereum?“

{
"tool": "x402_sentiment",
"arguments": {
"coin": "ETH"
}
}

Get a broad crypto market sentiment overview covering major coins and trends.

Free test endpoint: GET /market/test — returns fixture data, no wallet required. Paid endpoint: POST /market — $0.05 USDC on Base per call.

No parameters.

Returns: Market-wide sentiment data, top movers, and aggregate trend analysis across the crypto market.

Example:

“Give me a broad overview of the crypto market right now”

{
"tool": "x402_market_overview"
}

Get comprehensive multi-source intelligence analysis for a cryptocurrency.

Free test endpoint: GET /intelligence/test — returns fixture data, no wallet required. Paid endpoint: POST /intelligence — $0.10 USDC on Base per call.

ParameterTypeRequiredDefaultDescription
coinstringYesCryptocurrency ticker symbol (e.g., BTC, ETH, SOL) — 1–10 alphanumeric characters

Returns: Comprehensive analysis synthesized from multiple data sources: CoinGecko (market data), DeFiLlama (TVL and DeFi metrics), CryptoPanic (news), Fear & Greed Index (market psychology), and GitHub (development activity). Includes AI-generated actionable insights.

Example:

“Give me a deep intelligence report on Bitcoin”

{
"tool": "x402_intelligence",
"arguments": {
"coin": "BTC"
}
}

ToolPriceFree Test Mode
x402_network_infoFreeYes
x402_screenshot$0.01 USDCYes — example.com, example.org, httpbin.org only
x402_pdf_extract$0.01 USDCYes
x402_sentiment$0.01 USDCYes
x402_market_overview$0.05 USDCYes
x402_intelligence$0.10 USDCYes
x402_scrape_url$0.02 USDCYes
x402_convert_file$0.02 USDCYes
x402_web_search$0.01 USDCYes
x402_send_email$0.01 USDCYes
x402_transcribe_audio$0.05 USDCYes

See the individual API pages for full reference: Web Scraping, File Conversion, Web Search, Email Sending, Audio Transcription.

Payments are settled on Base (L2 Ethereum) in USDC. The x402 protocol handles payment negotiation transparently — your agent makes the request, the payment is authorized, and the data comes back in a single interaction.

No API key needed. See Getting Started to install and make your first free test call. Add a wallet when you’re ready to go paid.