Minswap

https://docs.minswap.org/
Admin
Minswap is a community-centric decentralized exchange (DEX) on Cardano that enables permissionless...
Tokens:50,216
Snippets:419
Trust Score:9.2
Update:5 months ago
Show doc for...
Tokens:
Raw
### Query Documentation via HTTP GET

Source: https://docs.minswap.org/min-token/usdmin-tokenomics/fee-switch

To get information not explicitly on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.minswap.org/min-token/usdmin-tokenomics/fee-switch.md?ask=<question>
```

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

### HTML Setup for Aggregator Widget

Source: https://docs.minswap.org/developer/aggregator-widget

Integrate the widget directly into an HTML file without a React build setup. Ensure the CSS is linked in the head and the script is placed in the body.

```html
<!DOCTYPE html>
<html>
  <head>
    <!-- Add this part to <head> -->
    <link
      rel="stylesheet"
      href="https://esm.sh/@minswap/aggregator-widget/dist/index.css"
    />
  </head>
  <body>
    <!-- Add this part to <body> -->
    <div id="minswap-widget"></div>
    <script type="importmap">
      {
        "imports": {
          "react": "https://esm.sh/react",
          "react-dom": "https://esm.sh/react-dom",
          "react-dom/": "https://esm.sh/react-dom/",
          "react/jsx-runtime": "https://esm.sh/react/jsx-runtime",
          "@minswap/aggregator-widget": "https://esm.sh/@minswap/aggregator-widget?external=react,react-dom"
        }
      }
    </script>
    <script type="module" src="https://esm.sh/tsx"></script>
    <script type="text/babel">
      import React from "react";
      import ReactDOMClient from "react-dom/client";
      import { Widget } from "@minswap/aggregator-widget";

      ReactDOMClient.createRoot(
        document.getElementById("minswap-widget")
      ).render(<Widget displayMode="full" partnerCode="your-partner-code" />);
    </script>
  </body>
</html>
```

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

### Query Minswap Documentation via HTTP GET

Source: https://docs.minswap.org/get-started/whitepaper

Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

```http
GET https://docs.minswap.org/get-started/whitepaper.md?ask=<question>
```

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

### Query Documentation via HTTP GET

Source: https://docs.minswap.org/courses/how-to-provide-liquidity/what-is-liquidity-provisioning

Use this method to dynamically query documentation. Perform an HTTP GET request on the current page URL, including the 'ask' query parameter with your question. The response will contain a direct answer and relevant excerpts.

```http
GET https://docs.minswap.org/courses/how-to-provide-liquidity/what-is-liquidity-provisioning.md?ask=<question>
```

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

### Query Documentation Dynamically

Source: https://docs.minswap.org/governance/liquidity-pool-fee-governance/vote-for-an-lp-fee-proposal

Use this GET request to query the documentation with a specific question. The response will include a direct answer and relevant excerpts.

```http
GET https://docs.minswap.org/governance/liquidity-pool-fee-governance/vote-for-an-lp-fee-proposal.md?ask=<question>
```

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

### Fetch Pool Metrics Example

Source: https://docs.minswap.org/developer/minswap-apis

Example of how to fetch pool metrics using curl. Specify the pool ID and optionally the currency for the response.

```bash
curl --location 'https://api-mainnet-prod.minswap.org/v1/pools/5f0d38b3eb8fea72cd3cbdaa9594a74d0db79b5a27e85be5e9015bd65553444d2d555344412d534c50/metrics?currency=usd'

```

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

### Install Aggregator Widget with npm

Source: https://docs.minswap.org/developer/aggregator-widget

Use npm to install the aggregator-widget package for your React project.

```bash
npm install @minswap/aggregator-widget
```

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

### Install Aggregator Widget with yarn

Source: https://docs.minswap.org/developer/aggregator-widget

Use yarn to install the aggregator-widget package for your React project.

```bash
yarn add @minswap/aggregator-widget
```

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

### Query Documentation with 'ask' Parameter

Source: https://docs.minswap.org/faq/zap-in

To get additional information not directly on the page, perform an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.minswap.org/faq/zap-in.md?ask=<question>
```

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

### Get All Asset Metrics

Source: https://docs.minswap.org/developer/minswap-apis

Retrieves metrics for multiple assets, allowing filtering and sorting. Use this to get a broad overview of asset performance.

```bash
curl --location 'https://api-mainnet-prod.minswap.org/v1/assets/metrics' \
--data '{ \
    "term": "", \
    "limit": 1, \
    "only_verified": true, \
    "sort_direction": "desc", \
    "sort_field": "liquidity", \
    "currency": "usd" \
}'
```

```json
{
    "search_after": [
        "9954917.19354675",
        "c48cbb3d5e57ed56e276bc45f99ab39abe94e6cd7ac39fb402da47ad.0014df105553444d"
    ],
    "asset_metrics": [
        {
            "asset": {
                "currency_symbol": "c48cbb3d5e57ed56e276bc45f99ab39abe94e6cd7ac39fb402da47ad",
                "token_name": "0014df105553444d",
                "is_verified": true,
                "metadata": {
                    "name": "USDM",
                    "url": "https://moneta.global/",
                    "ticker": "USDM",
                    "decimals": 6,
                    "description": "Fiat-backed stablecoin native to the Cardano blockchain"
                }
            },
            "total_supply": 0,
            "circulating_supply": 0,
            "created_at": "2024-03-17T00:21:21.000Z",
            "created_tx_id": "ac1cb7d3bc2a6e1a356b16c959e222608005524fc0c35919b63574d6b0b20b5a",
            "categories": [
                "Stablecoin"
            ],
            "price": 0.9975544277153409,
            "price_change_1h": 0.02207271877209818,
            "price_change_24h": -2.350271288070098,
            "price_change_7d": -0.09023188511685103,
            "volume_1h": 15276.40548938064,
            "volume_24h": 1058967.9023246677,
            "volume_7d": 7092205.7164879,
            "liquidity": 9954917.19354675,
            "market_cap": 0,
            "fully_diluted": 0
        }
    ]
}
```

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

### Install Aggregator Widget with pnpm

Source: https://docs.minswap.org/developer/aggregator-widget

Use pnpm to install the aggregator-widget package for your React project.

```bash
pnpm install @minswap/aggregator-widget
```

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

### Asset Response Example

Source: https://docs.minswap.org/developer/minswap-apis

Example JSON response structure for the assets endpoint, showing details like currency symbol, token name, verification status, and metadata including name, ticker, and decimals.

```json
{
  "search_after": [
    "1",
    "14110",
    "f66d78b4a3cb3d37afa0ec36461e51ecbde00f26c8f0a68f94b69880.69425443"
  ],
  "assets": [
    {
      "currency_symbol": "",
      "token_name": "",
      "is_verified": true,
      "metadata": {
        "decimals": 6,
        "name": "Cardano",
        "ticker": "ADA"
      }
    },
    {
      "currency_symbol": "c48cbb3d5e57ed56e276bc45f99ab39abe94e6cd7ac39fb402da47ad",
      "token_name": "0014df105553444d",
      "is_verified": true,
      "metadata": {
        "name": "USDM",
        "url": "https://moneta.global/",
        "ticker": "USDM",
        "decimals": 6,
        "description": "Fiat-backed stablecoin native to the Cardano blockchain"
      }
    }
  ]
}
```

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

### Query Documentation via HTTP GET

Source: https://docs.minswap.org/courses/how-to-provide-liquidity/risks-understanding-impermanent-loss

Use this method to ask questions about the documentation. The question should be specific and in natural language. The response includes direct answers and relevant excerpts.

```http
GET https://docs.minswap.org/courses/how-to-provide-liquidity/risks-understanding-impermanent-loss.md?ask=<question>
```

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

### Query Documentation Dynamically

Source: https://docs.minswap.org/courses/risks-and-rewards-of-using-minswap/what-is-a-liquidity-bootstrapping-event

Perform an HTTP GET request to query documentation dynamically. Use the 'ask' query parameter with a specific, self-contained question in natural language.

```HTTP
GET https://docs.minswap.org/courses/risks-and-rewards-of-using-minswap/what-is-a-liquidity-bootstrapping-event.md?ask=<question>
```

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

### Query Documentation Dynamically

Source: https://docs.minswap.org/courses/getting-started-and-best-safety-practices

Perform an HTTP GET request to query the documentation dynamically. Use the 'ask' query parameter with a specific, self-contained question in natural language. The response will include a direct answer and relevant excerpts.

```http
GET https://docs.minswap.org/courses/getting-started-and-best-safety-practices.md?ask=<question>
```

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

### Perform HTTP GET Request to Query Documentation

Source: https://docs.minswap.org/faq/token-launching-and-farming/3.-launchbowl-initiatives-rundown

Use this method to query the documentation dynamically. Append the 'ask' query parameter with your question to the current page URL. The question should be specific and in natural language.

```http
GET https://docs.minswap.org/faq/token-launching-and-farming/3.-launchbowl-initiatives-rundown.md?ask=<question>
```

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

### Basic Widget Integration (Full Display)

Source: https://docs.minswap.org/developer/aggregator-widget

Integrate the widget into your application with the 'full' display mode. Ensure you replace 'your-partner-code' with your actual partner code.

```jsx
import { Widget } from "@minswap/aggregator-widget";

function SwapInterface() {
  return <Widget partnerCode="your-partner-code" displayMode="full" />;
}
```

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

### Get Current ADA Price

Source: https://docs.minswap.org/developer/aggregator-api

Retrieves the current price of ADA in a specified currency and its 24-hour change.

```APIDOC
## GET /ada-price

### Description
Get current ADA price in multiple currencies.

### Method
GET

### Endpoint
/ada-price

### Parameters
#### Query Parameters
- **currency** (string) - Required - Currency code to get ADA price in. Common values: usd, eur, jpy.

### Responses
#### Success Response (200)
- **currency** (string) - The requested currency code in lowercase. Example: "usd", "eur", "gbp"
- **value** (object) - Price information (null if price data unavailable).
  - **change_24h** (number) - 24-hour price change percentage. Positive value: price increased. Negative value: price decreased. Example: -2.34 means price dropped 2.34%
  - **price** (number) - Current price in the requested currency. Example: 0.75 means 1 ADA = $0.75 USD

### Response Example
```json
{
  "currency": "usd",
  "value": {
    "change_24h": -2.34,
    "price": 0.75
  }
}
```
```

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

### Query Documentation Dynamically

Source: https://docs.minswap.org/courses/analytics-tools-and-insights

Perform an HTTP GET request to query documentation dynamically. Use this when information is not directly available on the page, requires clarification, or to retrieve related documentation sections.

```http
GET https://docs.minswap.org/courses/analytics-tools-and-insights.md?ask=<question>
```

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

### Get Asset Price Candlestick

Source: https://docs.minswap.org/developer/minswap-apis

Returns historical candlestick (OHLCV) price data for a specific asset, supporting custom time ranges and resolutions.

```APIDOC
## GET v1/assets/:id/price/candlestick

### Description
Returns historical candlestick (OHLCV) price data for a specific asset, supporting custom time ranges and resolutions.

### Method
GET

### Endpoint
`v1/assets/:id/price/candlestick`

### Parameters
#### Path Parameters
- **id** (string) - Required - The id parameter is a required string that uniquely identifies the asset for which metrics are being requested (ID asset in format: `{policy_id}{token_name}`)

#### Query Parameters
- **start_time** (number) - Optional - The Unix timestamp (in milliseconds) marking the start of the time range for the candlestick data.
- **end_time** (number) - Optional - The Unix timestamp (in milliseconds) marking the end of the time range for the candlestick data.
- **limit** (number) - Optional - Max results (min: `1`, max: `1000`). Default: `500`
- **interval** (CandlestickInterval) - Required - Candlestick interval.
- **currency** (SupportedCurrency) - Optional - Return values are in ADA if there is no value.

### Response
#### Success Response (200)
- **open** (number) - The opening price of the candlestick.
- **high** (number) - The highest price during the candlestick interval.
- **low** (number) - The lowest price during the candlestick interval.
- **close** (number) - The closing price of the candlestick.
- **volume** (number) - The trading volume during the candlestick interval.
- **timestamp** (number) - The Unix timestamp (in milliseconds) for the start of the candlestick interval.

### Request Example
```bash
curl --location 'https://api-mainnet-prod.minswap.org/v1/assets/0691b2fecca1ac4f53cb6dfb00b7013e561d1f34403b957cbb5af1fa4e49474854/price/candlestick?end_time=1766028002000&interval=15m&currency=usd'
```

### Response Example
```json
[
    {
        "open": 0.05150856356161587,
        "high": 0.05150856356161587,
        "low": 0.05047932810976648,
        "close": 0.050701693758410896,
        "volume": 50724.16443664555,
        "timestamp": 1765578600000
    },
    {
        "open": 0.05093382373126923,
        "high": 0.05093382373126923,
        "low": 0.05030821733861369,
        "close": 0.050525200451240655,
        "volume": 26361.171205892428,
        "timestamp": 1765579500000
    }
]
```
```

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

### Get Assets Metrics

Source: https://docs.minswap.org/developer/minswap-apis

Retrieve a paginated list of assets with trading and liquidity metrics (price, volume, liquidity, market cap, supply, etc.) for analytics.

```APIDOC
## POST /v1/assets/metrics

### Description
Retrieve a paginated list of assets with trading and liquidity metrics (price, volume, liquidity, market cap, supply, etc.) for analytics.

### Method
POST

### Endpoint
/v1/assets/metrics

### Parameters
#### Request Body
- **term** (string) - Optional - Search by asset name, currency symbol, token name, or ticker
- **limit** (number) - Optional - Number of results per page (min: 1, max: 100) - Default: 20
- **only_verified** (boolean) - Optional - Filter to show only verified tokens - Default: true
- **search_after** (string[]) - Optional - Pagination cursor from previous response
- **sort_direction** (string) - Optional - Sort order: `asc` or `desc` - Default: `desc`
- **sort_field** (string) - Optional - Sort by: `price_change_1h`, `price_change_24h`, `price_change_7d`, `volume_1h`, `volume_24h`, `volume_7d`, `liquidity`, `market_cap`, `fully_diluted`, `total_supply`, `circulating_supply` - Default: `volume_24h`
- **currency** (SupportedCurrency) - Optional - Return values are in ADA if there is no value

### Request Example
```json
{
  "term": "ADA",
  "limit": 10,
  "only_verified": true,
  "search_after": ["1", "14110", "f66d78b4a3cb3d37afa0ec36461e51ecbde00f26c8f0a68f94b69880.69425443"],
  "sort_direction": "asc",
  "sort_field": "market_cap",
  "currency": "ADA"
}
```

### Response
#### Success Response (200)
- **search_after** (string[]) - Pagination cursor for the next page of results.
- **asset_metrics** (AssetMetric[]) - An array of asset metrics.

```typescript
type AssetMetric = {
  asset: Asset;
  price_change_1h: number;
  price_change_24h: number;
  price_change_7d: number;
  volume_1h: number;
  volume_24h: number;
  volume_7d: number;
  total_supply: number;
  circulating_supply: number;
  created_at?: string;
  created_tx_id?: string;
  categories?: string[];
  price: number;
  liquidity: number;
  market_cap: number;
  fully_diluted: number;
}
```

#### Response Example
```json
{
  "search_after": ["2", "14111", "..."],
  "asset_metrics": [
    {
      "asset": {
        "currency_symbol": "",
        "token_name": "",
        "is_verified": true,
        "metadata": {
          "decimals": 6,
          "name": "Cardano",
          "ticker": "ADA"
        }
      },
      "price_change_1h": 0.5,
      "price_change_24h": 2.1,
      "price_change_7d": 5.0,
      "volume_1h": 100000,
      "volume_24h": 5000000,
      "volume_7d": 30000000,
      "total_supply": 34000000000,
      "circulating_supply": 33000000000,
      "price": 0.45,
      "liquidity": 10000000,
      "market_cap": 15000000000,
      "fully_diluted": 15000000000
    }
  ]
}
```
```

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

### Query Minswap API Documentation

Source: https://docs.minswap.org/developer/minswap-apis

Dynamically query the Minswap API documentation by appending an 'ask' query parameter to the documentation URL. This is useful for retrieving specific information not explicitly present or for clarification.

```http
GET https://docs.minswap.org/developer/minswap-apis.md?ask=<question>
```
Tokens:
Raw