> ## Documentation Index
> Fetch the complete documentation index at: https://docs.houdiniswap.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API v1 Introduction

> HoudiniSwap Partner API documentation

<Danger>
  Deprecation of the REST v1 swap endpoints begins on September 30, 2026. Please migrate to the Partner API v2. Dashboard and authentication endpoints remain on v1 GraphQL and are not affected. [Read the migration guide](https://docs.houdiniswap.com/migration/v1-to-v2)
</Danger>

# API v1

<Warning>
  **API v1 is for existing integrators only.** If you are building a new integration, use [API v2](/developer-hub/getting-started/authentication) — it offers unified endpoints, improved token handling, and WebSocket order updates.
</Warning>

<Warning>
  Never expose your API key and secret publicly. This API is meant to be used in a **backend environment**, not a frontend UI directly.
</Warning>

## Overview

The HoudiniSwap Partner API enables you to integrate private cryptocurrency swaps into your platform. The API supports both CEX (centralized) and DEX (decentralized) swap flows.

## Base URL

```text theme={null}
https://api-partner.houdiniswap.com/
```

## Authentication

All requests require an `Authorization` header using the format:

```text theme={null}
Authorization: <your API KEY>:<your API SECRET>
```

## Mandatory Fields

All exchange requests must include the following fields for compliance:

| Field       | Description                   |
| ----------- | ----------------------------- |
| `ip`        | User's IP address             |
| `userAgent` | Browser user agent string     |
| `timezone`  | User's timezone (e.g., `UTC`) |

## Core Workflow

1. **Authentication** – Verify your API credentials
2. **Get Currencies** – Retrieve supported tokens and network information
3. **Get Quote** – Obtain pricing data for a swap, including exchange rates and validity windows
4. **Initiate Exchange** – Execute the transaction with source/destination currencies and recipient address
5. **Get Status** – Monitor swap progress from initiation through completion