Welcome to Quickscope SDK Documentation
Welcome to the official documentation for the Quickscope SDK! We're excited to introduce our developer-friendly package for interacting with the Solana blockchain. Built by Quickscope, this SDK powers ultra-low-latency quoting, routing, and execution via our distributed router infrastructure.
About the Package
The @quickscope/sdk package was created to simplify and streamline programmatic access to decentralized liquidity across Solana. It’s designed to offer developers a seamless way to fetch quotes, build transactions, and execute token swaps using our globally distributed swap API.
Whether you're building trading bots, DeFi dashboards, or smart routing tools, the SDK gives you precise control and low-latency access to Quickscope’s infrastructure.
Key Features
Quote Intelligence
- getQuoteAll – Retrieve all available quotes across liquidity sources.
- getQuoteBest – Get the best quote based on price and fees.
- getQuoteCustom – Request a quote from a specific provider, pool, or AMM program.
Token Swaps
- getSwapBest – Generate a transaction for the best route.
- getSwapCustom – Build a swap transaction targeting a specific pool, program, or provider.
Transaction Utilities
- createTransaction – Deserialize a base64-encoded transaction into a VersionedTransaction object.
- sendTransaction – Sign and send a transaction with built-in retries and optional simulation.
- simulateTransaction – Simulate a transaction locally to preview errors or compute limits.
- sendBundle – Submit a pre-signed bundle of transactions via Jito for MEV protection and fast inclusion.
Metadata Utilities
- getProviders – View available liquidity providers supported by Quickscope.
- getMint – Retrieve mint info for a given token address.
- getPools – Discover pools supported across AMM programs.
Getting Started
Installation
To install the package, run:
npm install @quickscope/sdkUsage
Instantiation
import Quickscope from '@quickscope/sdk';
const quickscope = new Quickscope("frankfurt", "your-api-key");location can be either "frankfurt" or "nyc" – this determines which Quickscope router cluster to use, allowing low-latency routing based on your region.
Why Use This Package?
Distributed, Low-Latency Routing
Quickscope operates region-specific routers (e.g., frankfurt, nyc) colocated with private RPC nodes, enabling ultra-fast and reliable quoting and swap execution.
Developer-Focused Design
Built with developer needs in mind, the SDK gives you complete control over every step of the trade lifecycle—from quote to transaction submission.
Simulation-First Development
Avoid failed transactions with built-in support for dry-run simulations and bundle-based submission via Jito.
Easy Integration
From custom pools to priority fees, the SDK supports all the flexibility needed to build robust and production-grade DeFi applications.
Explore More
To explore each function in depth—including parameters, return types, and examples—check out the full documentation sections on:
Thank you for using the official SDK from Quickscope. We’re committed to helping you build faster, smarter, and more reliable DeFi applications on Solana.
If you have any feedback, questions, or integration requests—reach out. We’d love to hear from you.