Minswap APIs

This documentation provides comprehensive information about Minswap's public APIs for accessing pool metrics, asset data, and price information.

Table of Contents

Getting Started

Base URL: https://api-mainnet-prod.minswap.org

Rate Limiting

The API implements rate limiting to ensure fair usage. If you exceed the rate limit, you'll receive a 429 Too Many Requests response. Please implement appropriate retry logic with exponential backoff.

HTTP Status Codes

Status
Description
Notes

200

Success

Request completed successfully

400

Bad Request

Invalid parameters or request format

401

Unauthorized

Authentication failed (if required)

404

Not Found

Resource not found

429

Too Many Requests

Rate limit exceeded, please retry later

500

Internal Server Error

Server error, please contact support if persists

Error Response Format

Common Types

The following type definitions are used across multiple endpoints:

Assets APIs

1. Get List Assets

GET: /v1/assets

Description: Retrieve a paginated list of assets available on Minswap with their metadata and verification status. Use this endpoint to populate asset selection interfaces or search for specific assets.

Request Parameters

Parameter
Type
Required
Default
Description

term

string

No

""

Search by asset name, currency symbol, token name, or ticker

limit

number

No

20

Number of results per page (min: 1, max: 100)

only_verified

boolean

No

false

Filter to show only verified tokens

search_after

string[]

No

[]

Pagination cursor from previous response

Note: For pagination, use the search_after value from the previous response to get the next page of results.

Request Response

Example

2. Get Assets Metrics

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.

Request Body

Parameter
Type
Required
Default
Description

term

string

No

""

Search by asset name, currency symbol, token name, or ticker

limit

number

No

20

Number of results per page (min: 1, max: 100)

only_verified

boolean

No

true

Filter to show only verified tokens

search_after

string[]

No

[]

Pagination cursor from previous response

sort_direction

string

No

desc

Sort order: asc or desc

sort_field

string

No

volume_24h

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

currency

SupportedCurrency

No

-

Return values are in ADA if there is no value

Note: For pagination, use the search_after value from the previous response to get the next page of results.

Request Response

Example

3. Get Asset Metrics

GET: v1/assets/:id/metrics

Description: Retrieves detailed metrics for a specific asset by its ID, optionally filtered by display currency. It returns comprehensive asset statistics such as volume, liquidity, and price data for use in analytics or UI display.

Request Parameters

Parameter
Type
Required
Default
Description

id

string

Yes

-

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})

currency

SupportedCurrency

No

-

Return values are in ADA if there is no value

Request Response

Example

4. Get Asset Price Candlestick

GET: v1/assets/:id/price/candlestick

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

Request Parameters

Parameter
Type
Required
Default
Description

id

string

Yes

-

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})

start_time

number

No

-

The Unix timestamp (in milliseconds) marking the start of the time range for the candlestick data.

end_time

number

No

-

The Unix timestamp (in milliseconds) marking the end of the time range for the candlestick data.

limit

number

No

500

Max results (min: 1, max: 1000)

interval

CandlestickInterval

Yes

-

Candlestick interval.

currency

SupportedCurrency

No

-

Return values are in ADA if there is no value

Request Response

Example

5. Get Asset Price Timeseries

GET: v1/assets/:id/price/timeseries

Description: Retrieve simplified timeseries price data for a specific asset over a given period. Use this endpoint to analyze price trends and historical price movements.

Request Parameters

Parameter
Type
Required
Default
Description

id

string

Yes

-

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})

period

TimeSeriesPeriod

Yes

-

Time interval for aggregating the timeseries data

currency

SupportedCurrency

No

-

Return values are in ADA if there is no value

Request Response

Example

Pools APIs

Pools APIs provide comprehensive data about liquidity pools, including metrics, price history, and performance indicators.

1. Get Pools Metrics

POST: /v1/pools/metrics

Description: Retrieve a list of liquidity pools with their metrics including trading volume, liquidity, and trading fee APR. Use this endpoint to display pool statistics, compare pool performance, or filter pools by specific criteria.

Request Body

Parameter
Type
Required
Default
Description

term

string

No

""

Search by asset name, currency symbol, ticker, or LP asset

limit

number

No

20

Number of results per page (min: 1, max: 100)

only_verified

boolean

No

false

Filter to show only pools with verified tokens

search_after

string[]

No

[]

Pagination cursor from previous response

sort_direction

string

No

desc

Sort order: asc or desc

sort_field

string

Yes

liquidity

Sort by: volume_24h, volume_7d, or liquidity

protocols

string[]

No

All

Filter by protocol: Minswap, MinswapV2, MinswapStable

currency

SupportedCurrency

No

-

Return values are in ADA if there is no value

Request Response

Example

2. Get Pool Metrics by ID

GET: /v1/pools/:id/metrics

Description: Retrieve detailed metrics for a specific liquidity pool using its unique identifier (LP asset). Use this endpoint to display detailed pool information on pool detail pages.

Request Parameters

Parameter
Type
Required
Default
Description

id

string

Yes

-

LP asset ID combining policy ID and token name: {policy_id}{token_name}

currency

SupportedCurrency

No

-

Return values are in ADA if there is no value

Request Response

Example

3. Get Pool Price Candlestick

GET: /v1/pools/:id/price/candlestick

Description: Retrieve OHLCV (Open, High, Low, Close, Volume) candlestick data for a specific pool's price history. Use this endpoint to display price charts and historical trading data.

Request Parameters

Parameter
Type
Required
Default
Description

id

string

Yes

-

LP asset ID combining policy ID and token name: {policy_id}{token_name}

start_time

number

No

-

The Unix timestamp (in milliseconds) marking the start of the time range for the candlestick data.

end_time

number

No

-

The Unix timestamp (in milliseconds) marking the end of the time range for the candlestick data.

limit

number

No

500

Limit the number of candlestick records returned (min: 1, max: 1000)

interval

CandlestickInterval

Yes

-

Candlestick interval.

Request Response

Note: Results are sorted by timestamp in ascending order.

Example

4. Get Pool Price Timeseries

GET: /v1/pools/:id/price/timeseries

Description: Retrieve simplified timeseries price data for a specific pool over a given period. Use this endpoint for displaying price trends and historical price movements.

Request Parameters

Parameter
Type
Required
Default
Description

id

string

Yes

-

LP asset ID combining policy ID and token name: {policy_id}{token_name}

period

TimeSeriesPeriod

Yes

-

Time interval for aggregating the timeseries data

Request Response

Note: Results are sorted by timestamp in ascending order (oldest first).

Example

5. Get Pool Volume Timeseries

GET: v1/pools/:id/volume/timeseries

Description: Retrieve trading volume timeseries data for a specific pool over a given period. Use this endpoint to analyze trading activity and volume trends over time.

Request Parameters

Parameter
Type
Required
Default
Description

id

string

Yes

-

LP asset ID combining policy ID and token name: {policy_id}{token_name}

period

TimeSeriesPeriod

Yes

-

Time interval for aggregating the timeseries data

currency

SupportedCurrency

No

-

Return values are in ADA if there is no value

Request Response

Example

6. Get Pool TVL Timeseries

GET: v1/pools/:id/tvl/timeseries

Description: Retrieve total value locked (TVL) timeseries data for a specific pool over a given period. Use this endpoint to track liquidity changes and pool growth metrics over time.

Request Parameters

Parameter
Type
Required
Default
Description

id

string

Yes

-

LP asset ID combining policy ID and token name: {policy_id}{token_name}

period

TimeSeriesPeriod

Yes

-

Time interval for aggregating the timeseries data

currency

SupportedCurrency

No

-

Return values are in ADA if there is no value

Request Response

Example

7. Get Pool Fee Timeseries

GET: v1/pools/:id/fees/timeseries

Description: Retrieve accumulated trading fees timeseries data for a specific pool over a given period. Use this endpoint to analyze fee generation and revenue performance of liquidity pools.

Request Parameters

Parameter
Type
Required
Default
Description

id

string

Yes

-

LP asset ID combining policy ID and token name: {policy_id}{token_name}

period

TimeSeriesPeriod

Yes

-

Time interval for aggregating the timeseries data

currency

SupportedCurrency

No

-

Return values are in ADA if there is no value

Request Response

Example

Last updated

Was this helpful?