SDK Installation

Install a client library for the OpenScan.AI API in your preferred language.

The API is a plain REST API, so “installation” simply means adding an HTTP or web3 client to your project.

Prerequisites

JavaScript / TypeScript

• Node.js 18 or higher (built-in fetch)
• npm, yarn, or pnpm

Python

• Python 3.9 or higher
• pip

Installation

# No install needed for plain fetch (Node.js 18+)

# Optional: axios

npm install axios

# Optional: viem (REST + JSON-RPC companion)

npm install viem

# Optional: ethers.js

npm install ethers

Library details

fetch (JavaScript/TypeScript)

Built into Node.js 18+ and every modern browser — no dependencies. Best for scripts, serverless functions, and frontend apps.

• Docs: developer.mozilla.org/docs/Web/API/Fetch_API

axios (JavaScript/TypeScript)

Adds interceptors, automatic JSON handling, and timeouts — handy for attaching your API key to every request.

• Package: axios

viem (JavaScript/TypeScript)

A modern, type-safe web3 library. Use its HTTP transport for OpenScan.AI REST calls, or its JSON-RPC client for live chain reads.

• Package: viem

requests / httpx (Python)

The standard Python HTTP clients. httpx additionally supports async usage for high-concurrency crawls.

• Packages: requests, httpx

Next steps

• Quick Start — make your first API calls
• API Keys & Rate Limits — authenticate for higher limits
• Examples — complete scripts you can run today