### GET /swapped-ramp/readme/iframe-initialization.md

Source: https://docs.swapped.com/swapped-ramp/readme/iframe-initialization

Queries the documentation page for specific information using a natural language question and an optional goal.

```APIDOC
## GET /swapped-ramp/readme/iframe-initialization.md

### Description
Queries the documentation dynamically by asking a question. The response provides a direct answer along with relevant excerpts and sources.

### Method
GET

### Endpoint
https://docs.swapped.com/swapped-ramp/readme/iframe-initialization.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question.
- **excerpts** (array) - Relevant excerpts from the documentation.
- **sources** (array) - Sources used to generate the answer.
```

--------------------------------

### GET /swapped-connect/connect-integration/order-notifications.md

Source: https://docs.swapped.com/swapped-connect/connect-integration/order-notifications

Queries the documentation dynamically by providing a question and an optional goal.

```APIDOC
## GET /swapped-connect/connect-integration/order-notifications.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, or context related to the provided question.

### Method
GET

### Endpoint
https://docs.swapped.com/swapped-connect/connect-integration/order-notifications.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /swapped-connect/connect-integration.md

Source: https://docs.swapped.com/swapped-connect/connect-integration

Query the documentation dynamically by asking a question related to the integration.

```APIDOC
## GET /swapped-connect/connect-integration.md

### Description
Perform an HTTP GET request on the documentation page URL to retrieve answers to specific questions about the integration.

### Method
GET

### Endpoint
https://docs.swapped.com/swapped-connect/connect-integration.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal you are trying to accomplish.
```

--------------------------------

### Get Supported Endpoint Response

Source: https://docs.swapped.com/swapped-ramp/endpoints/misc.-endpoints/get-supported

Example JSON response structure for the get_supported endpoint.

```json
{
    "success": true,
    "data": {
        "supported_fiats": [
            {
                "iso": "BRL",
                "name": "Brazilian Real"
                "exchange_rate": "6.364674"
            }
        ],v
        "supported_cryptos": [
            {
                "id": 35,
                "name": "USDC (POL)",
                "iso": "USDC",
                "type": "token",
                "network": "polygon",
                "network_fee": "0",
                "tags": [
                    "USDC_POLYGON"
                ]
            }
        ],
        "supported_countries": [
            {
                "iso": "US",
                "name": "United States",
                "currency": "USD"
            }
        ]
    }
}
```

--------------------------------

### GET /swapped-connect/connect-integration/supported-connections.md

Source: https://docs.swapped.com/swapped-connect/connect-integration/supported-connections

Queries the documentation dynamically by asking a question related to the content.

```APIDOC
## GET /swapped-connect/connect-integration/supported-connections.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically. This is useful when the answer is not explicitly present in the page or additional context is required.

### Method
GET

### Endpoint
https://docs.swapped.com/swapped-connect/connect-integration/supported-connections.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### GET /swapped-ramp/off-ramp-integration/cryptocurrencies-and-confirmations.md

Source: https://docs.swapped.com/swapped-ramp/off-ramp-integration/cryptocurrencies-and-confirmations

Query the documentation dynamically by asking a question related to the content.

```APIDOC
## GET /swapped-ramp/off-ramp-integration/cryptocurrencies-and-confirmations.md

### Description
Perform an HTTP GET request on the documentation page URL to ask a specific question and retrieve information or context.

### Method
GET

### Endpoint
https://docs.swapped.com/swapped-ramp/off-ramp-integration/cryptocurrencies-and-confirmations.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /swapped-connect/connect-integration/iframe-initialization.md

Source: https://docs.swapped.com/swapped-connect/connect-integration/iframe-initialization

Queries the documentation page dynamically to retrieve answers or context based on a specific question and optional goal.

```APIDOC
## GET /swapped-connect/connect-integration/iframe-initialization.md

### Description
Performs a dynamic query against the documentation page to retrieve information or context.

### Method
GET

### Endpoint
https://docs.swapped.com/swapped-connect/connect-integration/iframe-initialization.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Payment Method Response Example

Source: https://docs.swapped.com/swapped-ramp/endpoints/onramp-endpoints/get-payment-methods

Example JSON response structure for a payment method object.

```json
{
  "id": 101,
  "name": "Card",
  "fee": 1.75,
  "slug": "creditcard-extra",
  "default": true,
  "currency": [
    "DKK",
    "GBP",
    "CHF",
    "JPY",
    "BRL",
    "IDR",
    "BGN",
    "VND"
  ],
  "base_fee": {
    "base_fee": 0.35
  },
  "disabled": false,
  "min_fee": 0,
  "min_amount": 7,
  "max_amount": 100000,
  "payment_group": "creditcard",
  "img_url": "https://widget.swapped.com/images/payment/creditcard.svg",
  "img_url_light": "https://widget.swapped.com/images/payment/creditcardlight.svg"
}
```

--------------------------------

### Get Transactions Response

Source: https://docs.swapped.com/swapped-ramp/endpoints/misc.-endpoints/get-transactions

Example JSON response containing a list of orders and pagination metadata.

```json
{
    "success": true,
    "data": {
        "orders": [
            {
                "order_id": "61b1d8f0-ab0e-4e18-b541-c62489d3869c",
                "created_at": "2025-11-10 00:32:20.812857+00",
                "updated_at": "2025-11-10 00:32:20.967135",
                "user_id": "8e93ccf4-5b44-4ce0-82d4-e64e0399a653",
                "order_total": 1529.27,
                "order_crypto": "XRP",
                "order_currency": "DKK",
                "order_status": "payment_pending",
                "order_payment_method": "bank-transfer",
                "order_type": "buy",
                "order_crypto_amount": 96.881233778549,
                "processing_fee": 7.65,
                "network_fee": 0,
                "fiat_rate": "7.467126",
                "blockchain_address": "raV5bXp9hNe5G4YFxLDSGHExL3bVyYmwZ9",
                "order_crypto_price": 2.06379,
                "transaction_id": null,
                "order_total_eur": 204.80034755005,
                "external_transaction_id": null,
                "external_customer_id": null,
                "merchant": "Test",
                "handling_fee": 3.932167,
                "response_url": "https://webhook.site/Swapped",
                "merchant_poi": false,
                "merchant_poa": false,
                "merchant_vip": false,
                "destination_tag": null,
                "crypto_network": "xrp",
                "markup": "0",
                "markup_total_eur": "0",
                "payment_group": "bank-transfer",
                "user_country": "BE"
            }
        ],
        "total": 1,
        "page": 1,
        "limit": 1,
        "pages": 1
    }
}
```

--------------------------------

### GET /swapped-ramp/readme/supported-fiat-currencies.md

Source: https://docs.swapped.com/swapped-ramp/readme/supported-fiat-currencies

Queries the documentation dynamically by providing a question and an optional goal.

```APIDOC
## GET /swapped-ramp/readme/supported-fiat-currencies.md

### Description
Performs an HTTP GET request to query the documentation dynamically. This is useful when the answer is not explicitly present in the current page or additional context is required.

### Method
GET

### Endpoint
https://docs.swapped.com/swapped-ramp/readme/supported-fiat-currencies.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### GET /swapped-ramp/off-ramp-integration.md

Source: https://docs.swapped.com/swapped-ramp/off-ramp-integration

Queries the documentation dynamically by providing a question and an optional goal.

```APIDOC
## GET /swapped-ramp/off-ramp-integration.md

### Description
Perform a query against the documentation to retrieve answers, excerpts, or context related to the off-ramp integration.

### Method
GET

### Endpoint
https://docs.swapped.com/swapped-ramp/off-ramp-integration.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /swapped-ramp/off-ramp-integration/iframe-initialization.md

Source: https://docs.swapped.com/swapped-ramp/off-ramp-integration/iframe-initialization

Queries the documentation for specific information by providing a natural language question and an optional end goal.

```APIDOC
## GET /swapped-ramp/off-ramp-integration/iframe-initialization.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present on the current page.

### Method
GET

### Endpoint
https://docs.swapped.com/swapped-ramp/off-ramp-integration/iframe-initialization.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained natural language question.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Get Transactions Request Body

Source: https://docs.swapped.com/swapped-ramp/endpoints/misc.-endpoints/get-transactions

Example JSON body for the POST request, including authentication parameters.

```json
{
    "apiKey": "public_key",
    "timestamp": "2025-05-16T09:38:25.000Z",
    "signature": "RAsRZUtDHhyY/On0qWZcxVdQ0AAQE+yUWk1/sf/pnI0="
}
```

--------------------------------

### GET /swapped-ramp/readme/onramp-aggregator-partners.md

Source: https://docs.swapped.com/swapped-ramp/readme/onramp-aggregator-partners

Query the documentation dynamically by performing an HTTP GET request on the documentation page URL.

```APIDOC
## GET /swapped-ramp/readme/onramp-aggregator-partners.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
https://docs.swapped.com/swapped-ramp/readme/onramp-aggregator-partners.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - Describes the broader end goal to tailor the answer.
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.swapped.com/swapped-connect/connect-integration

Perform a dynamic query against the documentation by appending ask and goal parameters to the page URL.

```http
GET https://docs.swapped.com/swapped-connect/connect-integration.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Get Minimum Amount Response

Source: https://docs.swapped.com/swapped-ramp/endpoints/misc.-endpoints/get-minimum-amount

Example JSON response structure returned by the get_min_amount endpoint.

```json
{
  "success": true,
  "data": {
    "EUR": 7,
    "GBP": 6,
    "BRL": 43,
    "RON": 35,
    "NOK": 83,
    "MYR": 34
  }
}
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.swapped.com/swapped-ramp/ai-integration-assistant

Perform a dynamic query against the documentation by appending the ask and goal parameters to the page URL.

```http
GET https://docs.swapped.com/swapped-ramp/ai-integration-assistant.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP

Source: https://docs.swapped.com/misc/order-notification-retry-policy

Perform an HTTP GET request to the documentation URL with 'ask' and 'goal' parameters to retrieve information dynamically.

```http
GET https://docs.swapped.com/misc/order-notification-retry-policy.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Response Data Structure

Source: https://docs.swapped.com/swapped-ramp/endpoints/offramp-endpoints/get-current-price

Example of the JSON response returned by the pricing endpoint.

```php
{
    "success": true,
    "data": {
        "crypto_amount": 0.16901475,
        "crypto_currency": "ETH",
        "crypto_unit_price": 3069.17,
        "network_fee": 0,
        "fiat_amount_incl_fees": 500,
        "fiat_amount_excl_fees": 481.9,
        "fiat_amount_incl_fees_local": 500,
        "fiat_amount_excl_fees_local": 481.9,
        "fiat_currency": "EUR",
        "markup_fiat_value": 0,
        "processing_fee": 18.1
    }
}
```

--------------------------------

### GET /swapped-ramp/readme/test-card.md

Source: https://docs.swapped.com/swapped-ramp/readme/test-card

Queries the documentation dynamically by providing a question and an optional goal.

```APIDOC
## GET /swapped-ramp/readme/test-card.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
https://docs.swapped.com/swapped-ramp/readme/test-card.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to tailor the answer.
```

--------------------------------

### GET https://widget.swapped.com/sell

Source: https://docs.swapped.com/swapped-ramp/off-ramp-integration/iframe-initialization

Initializes the off-ramp widget by loading the URL with the required API key and signature parameters.

```APIDOC
## GET https://widget.swapped.com/sell

### Description
Initializes the Swapped off-ramp iFrame widget. The request requires a signature generated from the query string using HMAC-SHA256.

### Parameters
#### Query Parameters
- **apiKey** (string) - Required - Your publishable API key.
- **signature** (string) - Required - HMAC-SHA256 signature of the full query string, base64-encoded.
- **email** (string) - Optional - Pre-fills the customer's email address.
- **customerKYC** (integer) - Optional - KYC level (0, 1, or 2).
- **externalCustomerId** (string) - Optional - Unique identifier for the customer.
- **baseCountry** (string) - Optional - User's ISO country code.
- **method** (string) - Optional - Payout method (e.g., bank transfer).
- **minAmount** (number) - Optional - Minimum order amount in EUR (min 7).
- **userSendsFunds** (boolean) - Optional - Enables merchant-led crypto sends (defaults to true).
- **fiatCurrencyCode** (string) - Optional - Fiat payout currency (required if userSendsFunds=false).
- **cryptoCurrencyCode** (string) - Optional - Crypto asset (required if userSendsFunds=false).
- **cryptoCurrencyAmount** (number) - Optional - Amount of crypto to send (required if userSendsFunds=false).
- **fiatCurrencyAmount** (number) - Optional - Amount of fiat to receive (required if userSendsFunds=false).
- **submerchant** (string) - Optional - Submerchant identifier.
```

--------------------------------

### GET /swapped-ramp/endpoints/onramp-endpoints.md

Source: https://docs.swapped.com/swapped-ramp/endpoints/onramp-endpoints

Query the documentation dynamically by performing an HTTP GET request on the documentation page URL.

```APIDOC
## GET /swapped-ramp/endpoints/onramp-endpoints.md

### Description
Query the documentation dynamically to retrieve information not explicitly present in the current page.

### Method
GET

### Endpoint
https://docs.swapped.com/swapped-ramp/endpoints/onramp-endpoints.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.swapped.com/swapped-ramp/endpoints/misc.-endpoints/get-minimum-amount

Perform an HTTP GET request to the documentation URL with query parameters to retrieve information.

```http
GET https://docs.swapped.com/swapped-ramp/endpoints/misc.-endpoints/get-minimum-amount.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /swapped-ramp/endpoints/offramp-endpoints.md

Source: https://docs.swapped.com/swapped-ramp/endpoints/offramp-endpoints

Query the documentation dynamically by performing an HTTP GET request on the page URL.

```APIDOC
## GET /swapped-ramp/endpoints/offramp-endpoints.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
https://docs.swapped.com/swapped-ramp/endpoints/offramp-endpoints.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### GET /swapped-ramp/endpoints/misc.-endpoints.md

Source: https://docs.swapped.com/swapped-ramp/endpoints/misc.-endpoints

Perform an HTTP GET request on the documentation page URL to query information dynamically using the ask and goal parameters.

```APIDOC
## GET https://docs.swapped.com/swapped-ramp/endpoints/misc.-endpoints.md

### Description
Query the documentation dynamically by asking a question to retrieve relevant excerpts and answers.

### Method
GET

### Endpoint
https://docs.swapped.com/swapped-ramp/endpoints/misc.-endpoints.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask.
- **goal** (string) - Optional - The broader end goal to tailor the answer.
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.swapped.com/swapped-ramp/endpoints/misc.-endpoints

Perform an HTTP GET request to the documentation URL with 'ask' and 'goal' parameters to retrieve specific information or context.

```http
GET https://docs.swapped.com/swapped-ramp/endpoints/misc.-endpoints.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /swapped-ramp/readme.md

Source: https://docs.swapped.com/swapped-ramp/readme

Queries the documentation dynamically by providing a question and an optional goal to receive a context-aware response.

```APIDOC
## GET /swapped-ramp/readme.md

### Description
Perform an HTTP GET request on the documentation page URL to query information dynamically. This is useful for retrieving details not explicitly covered in the static content.

### Method
GET

### Endpoint
https://docs.swapped.com/swapped-ramp/readme.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /swapped-ramp/readme/supported-cryptocurrencies.md

Source: https://docs.swapped.com/swapped-ramp/readme/supported-cryptocurrencies

Performs a dynamic query against the documentation page to retrieve answers and relevant excerpts.

```APIDOC
## GET /swapped-ramp/readme/supported-cryptocurrencies.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically for information not explicitly present in the page.

### Method
GET

### Endpoint
https://docs.swapped.com/swapped-ramp/readme/supported-cryptocurrencies.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to tailor the answer effectively.
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.swapped.com/misc

Use this request to retrieve answers or context from the documentation dynamically. The 'ask' parameter is required for the specific question, while 'goal' is optional for context.

```http
GET https://docs.swapped.com/misc.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Pricing Response Object

Source: https://docs.swapped.com/swapped-ramp/endpoints/onramp-endpoints/get-current-price

Example JSON response containing calculated crypto amounts, unit prices, and various fee breakdowns.

```json
{
    "success": true,
    "data": {
        "crypto_amount": 0.12284,
        "crypto_currency": "ETH",
        "crypto_unit_price": 4070.34,
        "network_fee": 0.2,
        "network_fee_local": 0.24,
        "fiat_amount_incl_fees": 440.85,
        "fiat_amount_excl_fees": 424.61,
        "fiat_amount_incl_fees_local": 519.12,
        "fiat_amount_excl_fees_local": 500,
        "fiat_currency": "USD",
        "markup_fiat_value": 20,
        "processing_fee": 19.11,
        "payment_method": "creditcard-extra",
        "payment_group": "creditcard"
    }
}
```

--------------------------------

### GET /misc/order-notification-retry-policy.md

Source: https://docs.swapped.com/misc/order-notification-retry-policy

Queries the documentation dynamically by providing a question and an optional goal.

```APIDOC
## GET /misc/order-notification-retry-policy.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically when information is not explicitly present or clarification is needed.

### Method
GET

### Endpoint
https://docs.swapped.com/misc/order-notification-retry-policy.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### GET /swapped-ramp/off-ramp-integration/supported-payout-methods.md

Source: https://docs.swapped.com/swapped-ramp/off-ramp-integration/supported-payout-methods

Queries the documentation dynamically to retrieve information or clarifications regarding the Swapped Ramp service.

```APIDOC
## GET /swapped-ramp/off-ramp-integration/supported-payout-methods.md

### Description
Performs a query against the documentation to retrieve answers, excerpts, or context related to the Swapped Ramp service.

### Method
GET

### Endpoint
https://docs.swapped.com/swapped-ramp/off-ramp-integration/supported-payout-methods.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /swapped-ramp/ai-integration-assistant.md

Source: https://docs.swapped.com/swapped-ramp/ai-integration-assistant

Queries the documentation assistant for information by providing a specific question and an optional end goal.

```APIDOC
## GET /swapped-ramp/ai-integration-assistant.md

### Description
Queries the documentation assistant to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.swapped.com/swapped-ramp/ai-integration-assistant.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the assistant.
- **goal** (string) - Optional - The broader end goal to help tailor the assistant's response.
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.swapped.com/llms.txt

Use this request to ask specific questions about the documentation. The question must be provided as a URL-encoded string in the ask parameter.

```http
GET https://docs.swapped.com/swapped-ramp/ai-integration-assistant.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP

Source: https://docs.swapped.com/swapped-ramp/endpoints/offramp-endpoints

Perform an HTTP GET request to the documentation URL with query parameters to retrieve specific information or context.

```http
GET https://docs.swapped.com/swapped-ramp/endpoints/offramp-endpoints.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /swapped-ramp/misc./supported-languages.md

Source: https://docs.swapped.com/swapped-ramp/misc./supported-languages

Performs a dynamic query against the documentation page to retrieve information not explicitly listed in the static content.

```APIDOC
## GET /swapped-ramp/misc./supported-languages.md

### Description
Performs an HTTP GET request on the documentation page to query for information using natural language.

### Method
GET

### Endpoint
https://docs.swapped.com/swapped-ramp/misc./supported-languages.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the response.
```

--------------------------------

### GET /swapped-ramp/endpoints.md

Source: https://docs.swapped.com/swapped-ramp/endpoints

Perform a dynamic query against the documentation to retrieve specific information or context.

```APIDOC
## GET /swapped-ramp/endpoints.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, or context based on a specific question.

### Method
GET

### Endpoint
https://docs.swapped.com/swapped-ramp/endpoints.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.

### Request Example
GET https://docs.swapped.com/swapped-ramp/endpoints.md?ask=How do I initiate an onramp?&goal=Integrate Swapped Ramp into my application

### Response
#### Success Response (200)
- **response** (string) - The direct answer to the question along with relevant documentation excerpts.
```

--------------------------------

### GET https://widget.swapped.com/api/v1/merchant/get_payment_methods

Source: https://docs.swapped.com/swapped-ramp/endpoints/onramp-endpoints/get-payment-methods

Retrieves a list of all payment methods and their supported countries.

```APIDOC
## GET https://widget.swapped.com/api/v1/merchant/get_payment_methods

### Description
Retrieves all payment methods and their supported countries. The response includes details such as fees, currency support, and transaction limits.

### Method
GET

### Endpoint
https://widget.swapped.com/api/v1/merchant/get_payment_methods

### Parameters
#### Query Parameters
- **apiKey** (string) - Optional - Your public API key to filter available methods.
- **include_mock_methods** (boolean) - Optional - If set to true, appends a fake method to every available country. Only available in sandbox.

### Response
#### Success Response (200)
- **id** (integer) - The payment method ID.
- **name** (string) - The name of the payment method.
- **fee** (number) - The fee percentage as an integer.
- **slug** (string) - The internal name for the payment method.
- **default** (boolean) - Whether the method is a default option.
- **currency** (array) - The currencies the payment method supports.
- **base_fee** (object) - The base fee in EUR for the payment method.
- **disabled** (boolean) - Whether the method is disabled or not.
- **min_fee** (number) - The minimum fee for the payment method in EUR.
- **min_amount** (number) - The minimum amount in EUR that this payment supports.
- **max_amount** (number) - The maximum amount in EUR that this payment supports.
- **payment_group** (string) - The group a payment method belongs to.
- **img_url** (string) - The standard image URL for the payment method logo.
- **img_url_light** (string) - The light theme variant image URL for the payment method logo.

#### Response Example
{
  "id": 101,
  "name": "Card",
  "fee": 1.75,
  "slug": "creditcard-extra",
  "default": true,
  "currency": ["DKK", "GBP", "CHF", "JPY", "BRL", "IDR", "BGN", "VND"],
  "base_fee": { "base_fee": 0.35 },
  "disabled": false,
  "min_fee": 0,
  "min_amount": 7,
  "max_amount": 100000,
  "payment_group": "creditcard",
  "img_url": "https://widget.swapped.com/images/payment/creditcard.svg",
  "img_url_light": "https://widget.swapped.com/images/payment/creditcardlight.svg"
}
```

--------------------------------

### GET /api/v1/merchant/get_supported

Source: https://docs.swapped.com/swapped-ramp/endpoints/misc.-endpoints/get-supported

Retrieves a list of all supported FIAT currencies, cryptocurrencies, and countries.

```APIDOC
## GET /api/v1/merchant/get_supported

### Description
Returns all standardised codes (ISOs) for supported FIAT currencies, cryptocurrencies, and countries.

### Method
GET

### Endpoint
/api/v1/merchant/get_supported

### Response
#### Success Response (200)
- **supported_fiats** (array) - Supported FIAT currencies.
- **supported_cryptos** (array) - Supported cryptocurrencies.
- **supported_countries** (array) - The supported countries.

#### Response Example
{
    "success": true,
    "data": {
        "supported_fiats": [
            {
                "iso": "BRL",
                "name": "Brazilian Real",
                "exchange_rate": "6.364674"
            }
        ],
        "supported_cryptos": [
            {
                "id": 35,
                "name": "USDC (POL)",
                "iso": "USDC",
                "type": "token",
                "network": "polygon",
                "network_fee": "0",
                "tags": ["USDC_POLYGON"]
            }
        ],
        "supported_countries": [
            {
                "iso": "US",
                "name": "United States",
                "currency": "USD"
            }
        ]
    }
}
```

--------------------------------

### GET /swapped-ramp/off-ramp-integration/order-notifications.md

Source: https://docs.swapped.com/swapped-ramp/off-ramp-integration/order-notifications

Queries the documentation page dynamically to retrieve answers and relevant excerpts based on a natural language question.

```APIDOC
## GET /swapped-ramp/off-ramp-integration/order-notifications.md

### Description
Queries the documentation page dynamically to retrieve answers and relevant excerpts based on a natural language question.

### Method
GET

### Endpoint
https://docs.swapped.com/swapped-ramp/off-ramp-integration/order-notifications.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### GET /swapped-ramp/readme/order-notifications.md

Source: https://docs.swapped.com/swapped-ramp/readme/order-notifications

Queries the documentation page dynamically to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /swapped-ramp/readme/order-notifications.md

### Description
Perform a dynamic query on the documentation page to retrieve information not explicitly present in the static content.

### Method
GET

### Endpoint
https://docs.swapped.com/swapped-ramp/readme/order-notifications.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
- The response contains a direct answer to the question along with relevant excerpts and sources from the documentation.
```

--------------------------------

### Example Postman Request Body

Source: https://docs.swapped.com/swapped-ramp/endpoints/misc.-endpoints/get-transactions

A sample JSON structure for a request body that includes the required authentication fields.

```json
{
  "apiKey": "{{apiKey}}",
  "timestamp": "{{timestamp}}",
  "order_id": "your_order_id_here",
  "signature": "{{signature}}"
}
```

--------------------------------

### GET /merchant/sell/get_payout_methods

Source: https://docs.swapped.com/swapped-ramp/endpoints/offramp-endpoints/get-payout-methods

Retrieves a list of all payment methods and their supported countries. Optionally filter by country slug.

```APIDOC
## GET https://widget.swapped.com/api/v1/merchant/sell/get_payout_methods

### Description
Retrieves all payment methods and their supported countries. The response can be filtered by providing a country slug.

### Method
GET

### Endpoint
https://widget.swapped.com/api/v1/merchant/sell/get_payout_methods

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Your API key for authentication.
- **slug** (string) - Optional - The country slug to filter the results.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object/array) - Contains the list of payment methods grouped by country or as a list depending on the query parameters.

#### Response Example
{
  "success": true,
  "data": {
    "BR": [
      {
        "id": 13,
        "name": "PIX",
        "fee": 2,
        "slug": "pix",
        "default": true,
        "currency": ["BRL"],
        "base_fee": {
          "base_fee": 0.1
        },
        "disabled": false,
        "min_amount": 7,
        "max_amount": 2400,
        "img_url": "https://widget.swapped.com/assets/payment/pix.svg",
        "img_url_light": "https://widget.swapped.com/assets/payment/pixlight.svg"
      }
    ]
  }
}
```

--------------------------------

### GET https://connect.swapped.com/

Source: https://docs.swapped.com/swapped-connect/connect-integration/iframe-initialization

Initializes the Swapped Connect interface via an iFrame. The request requires a signature generated using HMAC-SHA256 of the query string.

```APIDOC
## GET https://connect.swapped.com/

### Description
Loads the Swapped Connect interface within an iFrame. The request must be authenticated using a signature generated from the query parameters.

### Method
GET

### Endpoint
https://connect.swapped.com/

### Parameters
#### Query Parameters
- **apiKey** (string) - Required - Your public API key.
- **walletAddress** (string) - Required - The wallet address formatted as [ASSET]:[NETWORK]:[ADDRESS]:[AMOUNT].
- **signature** (string) - Required - A Base64 encoded SHA-256 HMAC signature of the query string generated using your secret API key.
```

--------------------------------

### GET /misc.md

Source: https://docs.swapped.com/misc

Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /misc.md

### Description
Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a specific question and optional goal.

### Method
GET

### Endpoint
https://docs.swapped.com/misc.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### Retrieve Payment Methods

Source: https://docs.swapped.com/swapped-ramp/endpoints/onramp-endpoints/get-payment-methods

Use this GET request to fetch all available payment methods. Append an apiKey to filter results by your specific merchant account.

```http
GET https://widget.swapped.com/api/v1/merchant/get_payment_methods?apiKey=YOUR_API_KEY
```

--------------------------------

### GET /api/v1/merchant/get_min_amount

Source: https://docs.swapped.com/swapped-ramp/endpoints/misc.-endpoints/get-minimum-amount

Retrieves the minimum accepted amounts for each fiat currency.

```APIDOC
## GET https://widget.swapped.com/api/v1/merchant/get_min_amount

### Description
Retrieves the minimum accepted amounts for each fiat currency. Note that these values are cached for 10 minutes and the endpoint is subject to a global rate limit of 100 requests per second.

### Method
GET

### Endpoint
https://widget.swapped.com/api/v1/merchant/get_min_amount

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - A map of currency codes to their respective minimum amounts.

#### Response Example
{
  "success": true,
  "data": {
    "EUR": 7,
    "GBP": 6,
    "BRL": 43,
    "RON": 35,
    "NOK": 83,
    "MYR": 34
  }
}
```

--------------------------------

### iFrame Initialization Parameters

Source: https://docs.swapped.com/swapped-connect/connect-integration/iframe-initialization

The Swapped Connect iFrame requires specific parameters to identify the customer, define destination wallet addresses, and verify request authenticity.

```APIDOC
## iFrame Initialization Parameters

### Description
To initialize the Swapped Connect iFrame, you must provide the following parameters to identify the user, specify the destination crypto wallets, and verify the request.

### Parameters
- **apiKey** (string) - Required - Your publishable API key for customer identification and session validation.
- **walletAddress** (string) - Required - The crypto wallet(s) where funds will be sent. Format: `CURRENCY:NETWORK:ADDRESS[:AMOUNT]`. Multiple entries can be comma-separated.
- **signature** (string) - Required - A cryptographic signature to verify the authenticity of the request.

### Wallet Address Format Details
- **CURRENCY**: Token symbol (e.g., BTC, SOL, ETH, USDT).
- **NETWORK**: On-chain network identifier (e.g., bitcoin, ethereum, solana).
- **ADDRESS**: The on-chain destination address.
- **AMOUNT** (Optional): Minimum deposit value in USD. Must be greater than 0.
```

--------------------------------

### Iframe Initialization Parameters

Source: https://docs.swapped.com/swapped-connect/connect-integration/iframe-initialization

Optional parameters that can be passed to the Swapped Connect iframe URL to customize the user experience and transaction flow.

```APIDOC
### Optional Parameters

- **baseCurrencyCode** (string) - The FIAT currency code for transactions (e.g., USD, EUR, GBP).
- **connection** (string) - The exchange platform or wallet to use (e.g., Binance, Coinbase, Kraken).
- **destinationTag** (string) - Numeric destination tag (XRP) or text memo (TON) for transaction context.
- **baseCountry** (string) - ISO country code for the user's location.
- **webhookUrl** (string) - URL-encoded URL to receive webhooks.
- **payWalletAddress** (string) - Crypto wallet address for Exchange Pay products. Format: `CURRENCY:NETWORK:ADDRESS:AMOUNT`.
- **externalCustomerId** (string) - Unique identifier for the customer.
- **preferredCurrencyToReceive** (string) - Preferred currency to receive. Format: `CURRENCY:NETWORK`.
- **name** (string) - URL-encoded merchant name to override the display name.
- **logo** (string) - URL-encoded HTTPS URL for the merchant logo.
```

--------------------------------

### Iframe Initialization

Source: https://docs.swapped.com/swapped-ramp/off-ramp-integration/iframe-initialization

Embed the Swapped off-ramp widget into your application using an iframe element.

```APIDOC
## Iframe Embed

### Description
Embed the Swapped off-ramp widget by pointing an iframe to the widget URL with your API key and order parameters.

### Implementation
```html
<iframe 
  allow="accelerometer; autoplay; camera; encrypted-media; gyroscope; payment; clipboard-read; clipboard-write" 
  src="https://widget.swapped.com/sell?apiKey={pk_live_key}&currencyCode=btc&signature=lorem" 
  title="Buy crypto with Swapped" 
  style="height: 585px; width: 445px; border-radius: 0.75rem; margin: auto;">
</iframe>
```
```

--------------------------------

### Order Notification Payloads

Source: https://docs.swapped.com/swapped-ramp/readme/order-notifications

Example JSON structures for various order status updates received via webhooks.

```json
{
  "order_id": "9af6cd02-174f-438f-a362-fc6545ad125b",
  "external_transaction_id": null,
  "external_customer_id": null,
  "order_status": "payment_pending",
  "order_crypto": "LTC",
  "order_type": "buy",
  "order_crypto_amount": "0.070175135286017",
  "order_crypto_address": "ltc1q2k0xaafhgt3s8qw03wmajjmlc8gcepdy0un0ah",
  "order_crypto_tag": null,
  "order_amount_usd": 8.18,
  "order_amount_usd_plus_fees": 8.9,
  "order_amount_eur": 7.01,
  "order_amount_eur_plus_fees": 7.62,
  "network": "litecoin"
}
```

```json
{
  "order_id": "9fcc45a5-4def-4953-9bd8-9ff75d9aaa9c",
  "order_crypto_amount": 0.070175135286017,
  "order_crypto": "LTC",
  "order_status": "order_completed",
  "order_crypto_address": "ltc1qlec2yfpkdvn4lr0vpf27qggrxtu34zeu5l6g2u",
  "external_customer_id": "1234567",
  "order_amount_usd": "25",
  "order_amount_usd_plus_fees": "25.5",
  "order_amount_eur": "21",
  "order_crypto_tag": 12345,
  "order_amount_eur_plus_fees": "22.5",
  "network": "litecoin"
}
```

```json
{
  "order_id": "9fcc45a5-4def-4953-9bd8-9ff75d9aaa9c",
  "order_crypto_amount": 0.070309096973144,
  "order_crypto": "LTC",
  "order_status": "order_broadcasted",
  "transaction_id": "ea458dda0ff8583199bdd4d9b9a69a2813694764a633fd40b27de22a868cebec",
  "order_crypto_address": "ltc1qlec2yfpkdvn4lr0vpf27qggrxtu34zeu5l6g2u",
  "external_customer_id": "1234567",
  "order_amount_usd": "25",
  "order_amount_usd_plus_fees": "25.5",
  "order_amount_eur": "21",
  "order_crypto_tag": 12345,
  "order_amount_eur_plus_fees": "22.5",
  "network": "litecoin"
}
```

```json
{
  "order_id": "9ab49879-92f0-44fc-992e-460285c879e8",
  "order_status": "order_cancelled",
  "order_type": "buy",
  "order_crypto": "LTC",
  "external_transaction_id": null,
  "external_customer_id": null
}
```

--------------------------------

### POST https://widget.swapped.com/api/v1/merchant/pricing

Source: https://docs.swapped.com/swapped-ramp/endpoints/onramp-endpoints/get-current-price

Retrieves pricing information for a specific fiat-to-crypto conversion request.

```APIDOC
## POST https://widget.swapped.com/api/v1/merchant/pricing

### Description
Retrieves current pricing information, including exchange rates and fees, for a specified fiat-to-crypto conversion.

### Method
POST

### Endpoint
https://widget.swapped.com/api/v1/merchant/pricing

### Parameters
#### Request Body
- **api_key** (string) - Required - The merchant's public key.
- **payment_method** (string) - Required - Payment method to use (e.g., creditcard).
- **fiat_currency** (string) - Required - The fiat currency to query.
- **fiat_amount** (number) - Optional - The fiat amount to convert.
- **crypto_currency** (string) - Required - The cryptocurrency to convert to.
- **crypto_amount** (number) - Optional - The cryptocurrency amount to convert to.
- **region** (string) - Required - The 2-letter ISO-3166 code of the country.
- **markup** (number) - Optional - An additional fee applied to the purchase price (0-5).

### Request Example
{
    "api_key": "",
    "payment_method": "creditcard",
    "fiat_currency": "USD",
    "fiat_amount": 500,
    "crypto_currency": "ETH",
    "region": "BE"
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains pricing details including crypto_amount, crypto_unit_price, network_fee, and various fiat amount breakdowns.

#### Response Example
{
    "success": true,
    "data": {
        "crypto_amount": 0.12284,
        "crypto_currency": "ETH",
        "crypto_unit_price": 4070.34,
        "network_fee": 0.2,
        "network_fee_local": 0.24,
        "fiat_amount_incl_fees": 440.85,
        "fiat_amount_excl_fees": 424.61,
        "fiat_amount_incl_fees_local": 519.12,
        "fiat_amount_excl_fees_local": 500,
        "fiat_currency": "USD",
        "markup_fiat_value": 20,
        "processing_fee": 19.11,
        "payment_method": "creditcard-extra",
        "payment_group": "creditcard"
    }
}
```

--------------------------------

### GET /swapped-ramp/misc..md

Source: https://docs.swapped.com/swapped-ramp/misc.

Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a natural language question.

```APIDOC
## GET /swapped-ramp/misc..md

### Description
Queries the documentation dynamically to retrieve information not explicitly present in the current page.

### Method
GET

### Endpoint
https://docs.swapped.com/swapped-ramp/misc..md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained natural language question.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### Listen for Order Data Events

Source: https://docs.swapped.com/swapped-ramp/off-ramp-integration/iframe-initialization

Add an event listener to the window object to capture order data posted from the widget. Always verify the event origin to ensure security.

```javascript
window.addEventListener('message', function (event) {
  // Verify origin
  if (event.origin !== 'https://widget.swapped.com') return

  const { type, data } = event.data
  if (type === 'SWAPPED_ORDER_DATA') {
    console.log('New order data:', data)
    // Optional: Update your UI
  }
})
```

--------------------------------

### Pricing Request with Markup

Source: https://docs.swapped.com/swapped-ramp/endpoints/onramp-endpoints/get-current-price

JSON request body including an optional markup parameter to apply a custom fee on a per-request basis.

```json
{
    "api_key": "",
    "payment_method": "creditcard",
    "fiat_currency": "USD",
    "fiat_amount": 500,
    "crypto_currency": "ETH",
    "crypto_amount": 1,
    "markup": 3,
    "region": "BE"
}
```