Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.range.org/llms.txt

Use this file to discover all available pages before exploring further.

​
Prerequisites

To use Faraday, you’ll need a Range API key. If you don’t already have one, follow the setup guide here.

​
Faraday SDK

The Faraday SDK provides a fully featured client for the Faraday API, making it simple to authenticate, build, and send requests.
  • Install the SDK and start integrating in minutes.
  • Written in TypeScript, compatible with both Node.js and browser environments.
  • Actively maintained and versioned alongside the Faraday API.

​
Install

npm
npm install @rangesecurity/faraday-sdk
yarn
yarn add @rangesecurity/faraday-sdk

​
Basic usage

import { FaradayClient } from "@rangesecurity/faraday-sdk";

const client = new FaradayClient({
  apiKey: process.env.RANGE_API_KEY,
});

// Get a quote for cross-chain transfer
const quote = await client.getQuote({
  fromChain: "ethereum",
  toChain: "solana",
  fromToken: "USDC",
  toToken: "USDC",
  amount: "1000",
});

console.log(quote);
📘 Info Visit the faraday-examples repository on GitHub to see ready-to-run integration examples using the Faraday SDK.

​
Rest API

The Faraday REST API gives you maximum control and flexibility over how you integrate. Faraday also offers a Swagger definition.
  • Use the OpenAPI specification to generate a client in your preferred language.
  • Supports the same endpoints and features as the SDK.
  • Ideal for teams building custom integrations or non-JavaScript environments.
⚠️ Important It’s strongly recommended to start in a test environment and verify your integration before using real funds.
Last modified on May 25, 2026