# SideShift.ai API Documentation

> SideShift.ai is a non-custodial cryptocurrency exchange API. It lets integrators add instant cross-chain swaps (called "shifts") and crypto payment acceptance to their applications. Users deposit one asset and SideShift settles another asset directly to a wallet address — no accounts, no custody.
> Append `.md` to any docs page URL to get a clean markdown version for LLM consumption.

## All Docs (single file)

- [All documentation combined](https://docs.sideshift.ai/all-docs.txt)
- [OpenAPI 3.0 spec (YAML)](https://docs.sideshift.ai/openapi.yaml)

## Common Use Cases

Use this section to find the right docs for what you're building.

### Swap / exchange crypto in your app (API)
Build a custom UI where users swap between 200+ coins across 42+ chains. You control the full flow: get a quote, create a shift, show the deposit address, and poll for settlement.
- Start here: [Getting Started](https://docs.sideshift.ai/api-intro/getting-started.md), [Shift Integration Guide](https://docs.sideshift.ai/api-intro/shift-integration-guide.md)
- Understand shifts: [Shift](https://docs.sideshift.ai/api-intro/shift.md), [Terminology](https://docs.sideshift.ai/api-intro/terminology.md)
- Fixed rate (locked price, exact deposit required): [Request quote](https://docs.sideshift.ai/endpoints/v2/requestquote.md) → [Create fixed shift](https://docs.sideshift.ai/endpoints/v2/createfixedshift.md)
- Variable rate (flexible deposit amount, rate set on-chain): [Create variable shift](https://docs.sideshift.ai/endpoints/v2/createvariableshift.md)
- Track status by polling: [Shift](https://docs.sideshift.ai/endpoints/v2/shift.md), [Deposits](https://docs.sideshift.ai/api-intro/deposits.md)

### Earn commission as an affiliate
Earn 0.5% (adjustable 0–2%) on every shift created with your affiliate ID. Configure thresholds and auto-withdrawal from your dashboard.
- [Monetization](https://docs.sideshift.ai/api-intro/monetization.md)

### List supported coins, networks, and pairs
Query available assets, trading pairs, min/max amounts, and network fees before building your UI.
- [Coins](https://docs.sideshift.ai/endpoints/v2/coins.md), [Pairs](https://docs.sideshift.ai/endpoints/v2/pairs.md), [Pair](https://docs.sideshift.ai/endpoints/v2/pair.md)

### Handle compliance and regional restrictions
Check whether a shift is allowed for a user's jurisdiction before creating it. Always forward the end-user's IP when calling from a server.
- [Permissions](https://docs.sideshift.ai/api-intro/permissions.md), [Permissions endpoint](https://docs.sideshift.ai/endpoints/v2/permissions.md)

## Key Concepts

- **Shift**: A single swap. A user deposits one asset ("deposit side") and receives another ("settle side") at a wallet address. Two types: fixed rate and variable rate.
- **Fixed rate shift**: Rate is locked via a quote for 15 minutes. The user must deposit the exact quoted amount. Created by first calling `/v2/quotes`, then `/v2/shifts/fixed` with the `quoteId`.
- **Variable rate shift**: One-step creation via `/v2/shifts/variable`. The rate is determined when the deposit is seen on-chain. Accepts any amount within the pair's min/max range and is valid for 7 days.
- **Quote**: A rate lock returned by `/v2/quotes`. Only used for fixed shifts. Expires after 15 minutes.
- **Deposit**: The asset the user sends to SideShift's generated `depositAddress` (and `depositMemo` if required by the chain).
- **Settlement**: The asset SideShift sends to the user's `settleAddress`. Statuses progress: `waiting` → `pending` → `processing` → `settled`.
- **Pair**: A supported deposit-coin/network ↔ settle-coin/network combination, with rate, min, max, and fee info.
- **affiliateId**: Your account ID, passed on API calls to attribute shifts and earn commission.
- **x-sideshift-secret**: Your private API key, required on authenticated endpoints (pair, pairs, shift creation).
- **Refund**: When a shift cannot be completed (e.g. wrong deposit amount), SideShift returns funds to the `refundAddress`. Set it at shift creation for automatic refunds; otherwise the shift stalls at `refund` status until a destination is supplied via `/v2/shifts/{shiftId}/set-refund-address`.
- **x-user-ip**: Must be set to the end-user's real IP when your server proxies API calls; required for accurate permission checks.

## API Introduction

- [Getting Started](https://docs.sideshift.ai/api-intro/getting-started.md)
- [Shift Integration Guide](https://docs.sideshift.ai/api-intro/shift-integration-guide.md)
- [API Terminology & Key Concepts](https://docs.sideshift.ai/api-intro/terminology.md)
- [How Crypto Shifts Work](https://docs.sideshift.ai/api-intro/shift.md)
- [Deposit Mechanics & Limits](https://docs.sideshift.ai/api-intro/deposits.md)
- [Earn Crypto Commissions](https://docs.sideshift.ai/api-intro/monetization.md)
- [User Permissions & Availability](https://docs.sideshift.ai/api-intro/permissions.md)
- [Network Fee Structure](https://docs.sideshift.ai/api-intro/network-fees.md)
- [Refund Process & Policies](https://docs.sideshift.ai/api-intro/refunds.md)
- [API Rate Limits](https://docs.sideshift.ai/api-intro/rate-limits.md)
- [API Endpoints Overview](https://docs.sideshift.ai/endpoints/endpoints-intro.md)
- [Support & Contact Options](https://docs.sideshift.ai/api-intro/support.md)

## Endpoints (V2)

- [Bulk Shift Lookup](https://docs.sideshift.ai/endpoints/v2/bulkshifts.md)
- [Cancel Order](https://docs.sideshift.ai/endpoints/v2/cancelorder.md)
- [Check Permissions](https://docs.sideshift.ai/endpoints/v2/permissions.md)
- [Coin Icon](https://docs.sideshift.ai/endpoints/v2/coinicon.md)
- [Create Account](https://docs.sideshift.ai/endpoints/v2/createaccount.md)
- [Create Fixed-Rate Shift](https://docs.sideshift.ai/endpoints/v2/createfixedshift.md)
- [Create Variable-Rate Shift](https://docs.sideshift.ai/endpoints/v2/createvariableshift.md)
- [Get Account Data](https://docs.sideshift.ai/endpoints/v2/account.md)
- [Get Recent Shifts](https://docs.sideshift.ai/endpoints/v2/recentshifts.md)
- [Get Shift Details](https://docs.sideshift.ai/endpoints/v2/shift.md)
- [Get Swap Pair Details](https://docs.sideshift.ai/endpoints/v2/pair.md)
- [List All Swap Pairs](https://docs.sideshift.ai/endpoints/v2/pairs.md)
- [List Supported Coins](https://docs.sideshift.ai/endpoints/v2/coins.md)
- [Request a Quote](https://docs.sideshift.ai/endpoints/v2/requestquote.md)
- [Set Refund Address](https://docs.sideshift.ai/endpoints/v2/setrefundaddress.md)
- [XAI Token Statistics](https://docs.sideshift.ai/endpoints/v2/xai-stats.md)

## Endpoints (V1)

- [Account](https://docs.sideshift.ai/endpoints/v1/account.md)
- [Create order (fixed)](https://docs.sideshift.ai/endpoints/v1/createorder-fixed.md)
- [Create order (variable)](https://docs.sideshift.ai/endpoints/v1/createorder-variable.md)
- [Fetch bulk orders](https://docs.sideshift.ai/endpoints/v1/fetchbulkorders.md)
- [Fetch bulk pairs](https://docs.sideshift.ai/endpoints/v1/fetchbulkpairs.md)
- [Fetch facts](https://docs.sideshift.ai/endpoints/v1/fetchfacts.md)
- [Fetch order](https://docs.sideshift.ai/endpoints/v1/fetchorder.md)
- [Fetch pair](https://docs.sideshift.ai/endpoints/v1/fetchpair.md)
- [Get permissions](https://docs.sideshift.ai/endpoints/v1/getpermissions.md)
- [Recent deposits](https://docs.sideshift.ai/endpoints/v1/recentdeposits.md)
- [Request a quote](https://docs.sideshift.ai/endpoints/v1/requestaquote.md)
- [Set refund address](https://docs.sideshift.ai/endpoints/v1/setrefundaddress.md)
- [XAI stats](https://docs.sideshift.ai/endpoints/v1/get-xai-stats.md)

## Other

- [API Error Codes Reference](https://docs.sideshift.ai/error-codes.md)
- [Changelog](https://docs.sideshift.ai/changelog.md)
- [Frequently Asked Questions](https://docs.sideshift.ai/faq.md)