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

# Overview

> Flexible APIs for lightning-fast cross-chain transactions.

export const Callout = ({type = 'info', children}) => {
  const borderColor = ({
    info: '#007acc',
    warning: '#FFC263',
    danger: '#d9534f',
    success: '#00C256'
  })[type] || '#ccc';
  const bgColor = ({
    info: '#f3f9ff',
    warning: '#FFF2DE',
    danger: '#f7f2f1',
    note: '#f8f8f8',
    tip: '#f1f1f8',
    success: '#E0FFEE'
  })[type] || '#f3f9ff';
  return <div style={{
    borderLeft: `4px solid ${borderColor}`,
    backgroundColor: bgColor,
    padding: '0.5rem',
    borderRadius: '12px',
    margin: '1rem 0',
    fontSize: '14px'
  }}>
      {children}
    </div>;
};

## Endpoint reference

### Core

| API                                                              | Description                                                    |
| :--------------------------------------------------------------- | :------------------------------------------------------------- |
| [Get Action](/swap-api-reference/get-action)                     | Generate a bridge, swap, or cross-chain call transaction.      |
| [Get Status](/swap-api-reference/get-status)                     | Track the status of a transaction based on its hash or ID.     |
| [Register Transaction](/swap-api-reference/register-transaction) | Trigger indexing for one or multiple broadcasted transactions. |

### Data

| API                                                      | Description                                          |
| :------------------------------------------------------- | :--------------------------------------------------- |
| [Get Transactions](/swap-api-reference/get-transactions) | Return transaction history based on desired filters. |

### Utilities

| API                                                  | Description                                                                     |
| :--------------------------------------------------- | :------------------------------------------------------------------------------ |
| [Get Paths](/swap-api-reference/get-paths)           | Retrieve available swap routes for given source token based on desired filters. |
| [Get Chain List](/swap-api-reference/get-chain-list) | Return list of all supported chains and their `VmId`s.                          |

### Workflows | All

| API                                                            | Description                                                                                         |
| :------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------- |
| [Get Action](/swap-api-reference/get-action)                   | Append a post execution hook to a bridge or swap transaction. **Enables prediction market routes.** |
| [Get User](/swap-api-reference/get-user)                       | Retrieve a Swaps Account for a user. Required for workflows.                                        |
| [Get Workflow Status](/swap-api-reference/get-workflow-status) | Track the status of a workflow execution.                                                           |

### Workflows | Polymarket

| API                                                               | Description                   |
| :---------------------------------------------------------------- | :---------------------------- |
| [Redeem Position](/swap-api-reference/polymarket/redeem-position) | Redeem a Polymarket position. |
| [Sell Position](/swap-api-reference/polymarket/sell-position)     | Sell a Polymarket position.   |

## Authentication

All API endpoints require authentication using API keys passed via the `x-api-key` header. We have provided a highly ratelimited API key for testing in the API playground.

<Callout type="info">Create a key in the [Console](https://console.swaps.xyz).</Callout>

## Related Resources

* [Send your first swap](/guides/swap) - Learn how to broadcast swap transactions
* [Call smart contracts across chains](/guides/calldata-call) - Deposit into [Aave](https://aave.com) on Base using ETH on Arbitrum