Skip to main content

​
Overview

The Faraday API provides secure, compliant infrastructure for stablecoin transactions, identity verification, and transaction monitoring across multiple blockchains.

Swap Routing

Discover optimal swap paths for stablecoin transfers, including cross-chain routes with best execution

Person Records

Create and manage IVMS101-compliant person data for FATF Travel Rule compliance

Transaction Management

Submit and track stablecoin transactions with real-time status updates

Reporting

Access historical transaction reports with associated compliance records

​
Authentication

All Faraday API requests require authentication using a Bearer token (API key).

​
Getting Your API Key

Step-by-Step:
  1. Sign In — Log in to the Range platform:
  2. Navigate to APIs — Find the “APIs” section in the left navigation menu
  3. Copy Your Key — Your API key will be displayed. Copy it for use in your requests
A free monthly credit allowance is available for all accounts. Paid plans offer additional credits for higher volume usage.

​
Using Your API Key

Include your API key in the Authorization header of every request: 
curl -X GET 'https://api.faraday.range.org/v1/persons' \
  --header 'Authorization: Bearer YOUR_API_KEY'

​
Base URLs

  • Production
  • Staging
  • Local Development
Base URL: https://api.faraday.range.orgUse this environment for live transactions with real funds.

​
Core Endpoints

​
Quote & Routing

Get the best execution path for stablecoin transfers:
EndpointMethodDescription
/v1/transactions/quoteGETRequest a quote for a stablecoin transfer
/v1/chainsGETList all supported blockchains
/v1/aggregatorsGETView integrated DEX aggregators

​
Person Records (IVMS101)

Manage compliance records for Travel Rule requirements:
EndpointMethodDescription
/v1/personsPOSTCreate a new person record
/v1/personsGETList all person records
/v1/persons/{id}GETRetrieve a specific person record
/v1/persons/{id}PUTUpdate an existing person record
/v1/persons/{id}DELETEDelete a person record

​
Transaction Management

Submit and monitor stablecoin transactions:
EndpointMethodDescription
/v1/transactionsPOSTSubmit a new transaction
/v1/transactionsGETList transactions
/v1/transactions/{id}GETGet transaction details and status

​
Reporting

Access historical data and compliance reports:
EndpointMethodDescription
/v1/reports/transactionsGETGenerate transaction history reports

​
Rate Limits

API rate limits vary by plan:
PlanRate LimitCredits/Month
Free10 requests/min100 credits
Pro100 requests/min10,000 credits
EnterpriseCustomCustom
Rate limit headers are included in every response: - X-RateLimit-Limit — Maximum requests per window - X-RateLimit-Remaining — Requests remaining - X-RateLimit-Reset — Time when limit resets (Unix timestamp)

​
Error Handling

Faraday uses conventional HTTP response codes:
CodeStatusDescription
200OKRequest succeeded
400Bad RequestInvalid request parameters
401UnauthorizedMissing or invalid API key
403ForbiddenAPI key lacks required permissions
404Not FoundResource does not exist
429Too Many RequestsRate limit exceeded
500Internal Server ErrorServer error (contact support)

​
Error Response Format

{
  "error": {
    "code": "invalid_request",
    "message": "The 'amount' field is required",
    "details": {
      "field": "amount",
      "issue": "missing_required_field"
    }
  }
}

​
Quick Start Example

Here’s a complete example of getting a quote and submitting a transaction: 
import { FaradayClient } from '@rangesecurity/faraday-sdk';

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

// 1. Get a quote
const quote = await faraday.getQuote({
sourceChain: 'solana',
sourceToken: 'USDT',
destChain: 'ethereum',
destToken: 'USDC',
amount: '1000',
slippageBps: 50
});

console.log('Quote:', quote);

// 2. Execute the transaction
const tx = await faraday.executeQuote(quote.id);

console.log('Transaction submitted:', tx.id);

// 3. Monitor status
const status = await faraday.getTransaction(tx.id);
console.log('Status:', status.state);

​
OpenAPI Specification

For complete API details, use our OpenAPI specification to generate clients in any language: OpenAPI JSON: https://api.faraday.range.org/api-docs/openapi.json

View Full API Docs

Interactive API reference with all endpoints

Integration Guide

Step-by-step guide to integrating Faraday

SDK Documentation

TypeScript SDK repository and documentation

Code Examples

Ready-to-run example code on GitHub

​
Need Help?

FAQ

Common questions about Faraday API

Get Support

Contact our team for assistance