• Health
  • getHealth Check
• Router
  • getGet Router Configuration
• Pools
  • getList All Pools
  • getGet Pool Details
  • getGet Pool Transactions
  • getGet Pool Volume History
  • getGet Pool Price History
  • getGet Pool Liquidity History
  • getGet All Pools Volume History
  • getGet All Pools Liquidity History
• Quotation
  • postGet Swap Quotation
  • postGet Add Liquidity Quotation
• Tokens
  • getList All Tokens
  • getGet Token Volume History
  • getGet Token Price History
  • getGet All Tokens Volume History
• Token Factory
  • getList Factory Tokens
  • getList Tokens by Creator
• KFI Stats
  • getGet KFI Statistics
• Portfolio
  • getGet Token Balances
  • getGet Full Portfolio
  • getGet Close Position Data
• Rewards
  • getGet Rewards Status
• Energy
  • getGet Energy and KFI Balances
  • getGet Energy Removal Penalty
  • postGet Multiple Energy Removal Penalties
  • getGet Energy Positions
  • getGet Unlocked Tokens

API docs by Redocly

Bitcoin.me DeFi API (1.0.0)

Download OpenAPI specification:Download

URL: https://bitcoin.me

REST API for integration with the Bitcoin.me DeFi platform on KleverChain.

This API provides endpoints for:

• Pools: Query liquidity pools and their details
• Quotation: Get swap and liquidity quotes
• History: Historical data (volume, price, liquidity) for pools and tokens
• Tokens: List available tokens
• Token Factory: Manage created tokens
• Portfolio: View wallet balances and positions
• Rewards: Check reward status
• Energy: Manage energy positions and KFI locking

Health

API health check

Health Check

Checks the API status.

Responses

Production API

https://api.bitcoin.me/health

Testnet API

https://api.staging.bitcoin.me/health

Response samples

• 200

Content type

application/json

{

• "status": "OK"

}

Router

Router configuration

Get Router Configuration

Returns the swap router configuration.

Responses

Production API

https://api.bitcoin.me/router/config

Testnet API

https://api.staging.bitcoin.me/router/config

Response samples

• 200

Content type

application/json

{

• "lockedTokenId": "string",
• "minLockedTokenValue": "string",
• "minLockPeriodEpochs": "string"

}

Pools

Liquidity pools operations

List All Pools

Lists all available liquidity pools.

Responses

Production API

https://api.bitcoin.me/pools

Testnet API

https://api.staging.bitcoin.me/pools

Response samples

• 200

Content type

application/json

[

• {

  • "scAddress": "string",
  • "name": "string",
  • "value": "string",
  • "apr": "string",
  • "baseName": "string",
  • "quoteName": "string",
  • "baseAssetId": "string",
  • "quoteAssetId": "string",
  • "baseIconUrl": "string",
  • "quoteIconUrl": "string",
  • "baseTotalStaked": "string",
  • "quoteTotalStaked": "string"

  }

]

Get Pool Details

Returns the details of a specific pool.

path Parameters

scAddress required

string Smart contract address of the pool

Responses

Production API

https://api.bitcoin.me/pools/{scAddress}

Testnet API

https://api.staging.bitcoin.me/pools/{scAddress}

Response samples

• 200
• 404

Content type

application/json

{

• "scAddress": "string",
• "name": "string",
• "value": "string",
• "apr": "string",
• "baseName": "string",
• "quoteName": "string",
• "baseAssetId": "string",
• "quoteAssetId": "string",
• "baseIconUrl": "string",
• "quoteIconUrl": "string",
• "baseTotalStaked": "string",
• "quoteTotalStaked": "string",
• "baseTokenPrice": "string",
• "quoteTokenPrice": "string",
• "basePriceVariation": "string",
• "quotePriceVariation": "string",
• "baseVolume": "string",
• "quoteVolume": "string",
• "fees": "string"

}

Get Pool Transactions

Returns the latest swap transactions of a pool.

path Parameters

scAddress required

string Smart contract address of the pool

Responses

Production API

https://api.bitcoin.me/pools/transactions/{scAddress}

Testnet API

https://api.staging.bitcoin.me/pools/transactions/{scAddress}

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "action": "string",
  • "tokenInAbbr": "string",
  • "tokenInAmount": "string",
  • "tokenInAmountUsd": "string",
  • "tokenInAssetId": "string",
  • "tokenInIcon": "string",
  • "tokenOutAbbr": "string",
  • "tokenOutAmount": "string",
  • "tokenOutAmountUsd": "string",
  • "tokenOutAssetId": "string",
  • "tokenOutIcon": "string",
  • "timestamp": 0

  }

]

Get Pool Volume History

Returns the volume history for a specific liquidity pool, broken down by time buckets.

All history endpoints require an active ElasticSearch connection. If ElasticSearch is unavailable, a 503 Service Unavailable response is returned.

path Parameters

scAddress required

string Smart contract address of the pool

query Parameters

granularity	string Default: "1d" Enum: "1h" "1d" "1w" Time bucket size. Valid values: 1h, 1d, 1w
days	integer [ 1 .. 365 ] Default: 30 Number of days to look back. Range: 1 to 365

Responses

Production API

https://api.bitcoin.me/pools/{scAddress}/history/volume

Testnet API

https://api.staging.bitcoin.me/pools/{scAddress}/history/volume

Response samples

• 200
• 400
• 404
• 503

Content type

application/json

{

• "scAddress": "string",
• "baseToken": "string",
• "quoteToken": "string",
• "baseTokenPrice": "string",
• "quoteTokenPrice": "string",
• "data": [

  • {

    • "timestamp": 0,
    • "baseVolume": "string",
    • "quoteVolume": "string"

    }

  ]

}

Get Pool Price History

Returns the VWAP (Volume-Weighted Average Price) history for a specific pool.

Price calculations use VWAP: sum(price × volume) / sum(volume).

path Parameters

scAddress required

string Smart contract address of the pool

query Parameters

granularity	string Default: "1d" Enum: "1h" "1d" "1w" Time bucket size. Valid values: 1h, 1d, 1w
days	integer [ 1 .. 365 ] Default: 30 Number of days to look back. Range: 1 to 365

Responses

Production API

https://api.bitcoin.me/pools/{scAddress}/history/price

Testnet API

https://api.staging.bitcoin.me/pools/{scAddress}/history/price

Response samples

• 200
• 400
• 404
• 503

Content type

application/json

{

• "scAddress": "string",
• "baseToken": "string",
• "quoteToken": "string",
• "data": [

  • {

    • "timestamp": 0,
    • "basePrice": "string",
    • "quotePrice": "string"

    }

  ]

}

Get Pool Liquidity History

Returns the TVL (Total Value Locked) history for a specific pool, reconstructed from on-chain liquidity events.

Liquidity history is reconstructed backwards from current reserves by undoing on-chain add/remove liquidity events. This endpoint is cached for 10 minutes.

path Parameters

scAddress required

string Smart contract address of the pool

query Parameters

granularity	string Default: "1d" Enum: "1h" "1d" "1w" Time bucket size. Valid values: 1h, 1d, 1w
days	integer [ 1 .. 365 ] Default: 30 Number of days to look back. Range: 1 to 365

Responses

Production API

https://api.bitcoin.me/pools/{scAddress}/history/liquidity

Testnet API

https://api.staging.bitcoin.me/pools/{scAddress}/history/liquidity

Response samples

• 200
• 400
• 404
• 503

Content type

application/json

{

• "scAddress": "string",
• "baseToken": "string",
• "quoteToken": "string",
• "data": [

  • {

    • "timestamp": 0,
    • "baseAmount": "string",
    • "quoteAmount": "string",
    • "totalValueUsd": "string"

    }

  ]

}

Get All Pools Volume History

Returns volume history for all pools in a single request.

Responses are cached for 10 minutes in Redis.

query Parameters

granularity	string Default: "1d" Enum: "1h" "1d" "1w" Time bucket size. Valid values: 1h, 1d, 1w
days	integer [ 1 .. 365 ] Default: 30 Number of days to look back. Range: 1 to 365

Responses

Production API

https://api.bitcoin.me/pools/history/volume

Testnet API

https://api.staging.bitcoin.me/pools/history/volume

Response samples

• 200
• 400
• 503

Content type

application/json

{

• "pools": [

  • {

    • "scAddress": "string",
    • "baseToken": "string",
    • "quoteToken": "string",
    • "baseTokenPrice": "string",
    • "quoteTokenPrice": "string",
    • "data": [

      • {

        • "timestamp": 0,
        • "baseVolume": "string",
        • "quoteVolume": "string"

        }

      ]

    }

  ]

}

Get All Pools Liquidity History

Returns liquidity (TVL) history for all pools in a single request.

Responses are cached for 10 minutes in Redis.

query Parameters

granularity	string Default: "1d" Enum: "1h" "1d" "1w" Time bucket size. Valid values: 1h, 1d, 1w
days	integer [ 1 .. 365 ] Default: 30 Number of days to look back. Range: 1 to 365

Responses

Production API

https://api.bitcoin.me/pools/history/liquidity

Testnet API

https://api.staging.bitcoin.me/pools/history/liquidity

Response samples

• 200
• 400
• 503

Content type

application/json

{

• "pools": [

  • {

    • "scAddress": "string",
    • "baseToken": "string",
    • "quoteToken": "string",
    • "data": [

      • {

        • "timestamp": 0,
        • "baseAmount": "string",
        • "quoteAmount": "string",
        • "totalValueUsd": "string"

        }

      ]

    }

  ]

}

Quotation

Swap and liquidity quotations

Get Swap Quotation

Gets the swap quotation between two tokens.

Request Body schema: application/json

required

amountIn required	number Input token amount
tokenIn required	string Input token asset ID
tokenOut required	string Output token asset ID

Responses

Production API

https://api.bitcoin.me/quotation

Testnet API

https://api.staging.bitcoin.me/quotation

Request samples

• Payload

Content type

application/json

{

• "amountIn": 0,
• "tokenIn": "string",
• "tokenOut": "string"

}

Response samples

• 200
• 400

Content type

application/json

{

• "tokenIn": "string",
• "amountIn": "string",
• "amountInUsd": "string",
• "tokenOut": "string",
• "amountOut": "string",
• "amountOutUsd": "string",
• "tokenInPrice": "string",
• "tokenOutPrice": "string",
• "tokenInPriceUsd": "string",
• "tokenOutPriceUsd": "string",
• "tokenInPrecision": 0,
• "tokenOutPrecision": 0

}

Get Add Liquidity Quotation

Gets the quotation for adding liquidity to a pool.

Request Body schema: application/json

required

amountIn required	number Input token amount
tokenIn required	string Input token asset ID
tokenOut required	string Output token asset ID

Responses

Production API

https://api.bitcoin.me/quotation/add-liquidity

Testnet API

https://api.staging.bitcoin.me/quotation/add-liquidity

Request samples

• Payload

Content type

application/json

{

• "amountIn": 0,
• "tokenIn": "string",
• "tokenOut": "string"

}

Response samples

• 200

Content type

application/json

{

• "tokenIn": "string",
• "amountIn": "string",
• "amountInUsd": "string",
• "tokenOut": "string",
• "amountOut": "string",
• "amountOutUsd": "string",
• "tokenInPrice": "string",
• "tokenOutPrice": "string",
• "tokenInPriceUsd": "string",
• "tokenOutPriceUsd": "string",
• "tokenInPrecision": 0,
• "tokenOutPrecision": 0

}

Tokens

Token listing

List All Tokens

Lists all tokens available in pools.

Responses

Production API

https://api.bitcoin.me/tokens

Testnet API

https://api.staging.bitcoin.me/tokens

Response samples

• 200

Content type

application/json

[

• {

  • "tokenInID": "string",
  • "tokenInAbbr": "string",
  • "iconURL": "string",
  • "price": "string",
  • "variationPercent": 0,
  • "lastVolume": "string"

  }

]

Get Token Volume History

Returns volume history for a specific token across all pools that include it. Includes price data (best-effort) from the first matching pool.

The price field is enriched on a best-effort basis. If no pool with price data is available, the field will be omitted from the response.

path Parameters

tokenId required

string Asset ID of the token (e.g., KLV, KFI)

query Parameters

granularity	string Default: "1d" Enum: "1h" "1d" "1w" Time bucket size. Valid values: 1h, 1d, 1w
days	integer [ 1 .. 365 ] Default: 30 Number of days to look back. Range: 1 to 365

Responses

Production API

https://api.bitcoin.me/tokens/{tokenId}/history/volume

Testnet API

https://api.staging.bitcoin.me/tokens/{tokenId}/history/volume

Response samples

• 200
• 400
• 503

Content type

application/json

{

• "tokenId": "string",
• "data": [

  • {

    • "timestamp": 0,
    • "volume": "string",
    • "price": "string"

    }

  ]

}

Get Token Price History

Returns price history for a specific token across all pools that contain it. Each pool entry includes VWAP price data points.

path Parameters

tokenId required

string Asset ID of the token (e.g., KLV, KFI)

query Parameters

granularity	string Default: "1d" Enum: "1h" "1d" "1w" Time bucket size. Valid values: 1h, 1d, 1w
days	integer [ 1 .. 365 ] Default: 30 Number of days to look back. Range: 1 to 365

Responses

Production API

https://api.bitcoin.me/tokens/{tokenId}/history/price

Testnet API

https://api.staging.bitcoin.me/tokens/{tokenId}/history/price

Response samples

• 200
• 400
• 404
• 503

Content type

application/json

{

• "tokenId": "string",
• "pools": [

  • {

    • "poolAddress": "string",
    • "quoteToken": "string",
    • "data": [

      • {

        • "timestamp": 0,
        • "basePrice": "string",
        • "quotePrice": "string"

        }

      ]

    }

  ]

}

Get All Tokens Volume History

Returns volume history for all tokens, grouped by token ID.

query Parameters

granularity	string Default: "1d" Enum: "1h" "1d" "1w" Time bucket size. Valid values: 1h, 1d, 1w
days	integer [ 1 .. 365 ] Default: 30 Number of days to look back. Range: 1 to 365

Responses

Production API

https://api.bitcoin.me/tokens/history/volume

Testnet API

https://api.staging.bitcoin.me/tokens/history/volume

Response samples

• 200
• 400
• 503

Content type

application/json

{

• "data": [

  • {

    • "tokenId": "string",
    • "data": [

      • {

        • "timestamp": 0,
        • "volume": "string",
        • "price": "string"

        }

      ]

    }

  ]

}

Token Factory

Token creation and management

List Factory Tokens

Lists all tokens created in the factory.

Responses

Production API

https://api.bitcoin.me/token-factory/tokens

Testnet API

https://api.staging.bitcoin.me/token-factory/tokens

Response samples

• 200

Content type

application/json

{

• "tokens": [

  • { }

  ]

}

List Tokens by Creator

Lists tokens created by a specific address.

path Parameters

address required

string Bech32 address of the creator

Responses

Production API

https://api.bitcoin.me/token-factory/tokens/{address}

Testnet API

https://api.staging.bitcoin.me/token-factory/tokens/{address}

Response samples

• 200
• 400

Content type

application/json

{

• "tokens": [

  • { }

  ]

}

KFI Stats

KFI token statistics

Get KFI Statistics

Returns KFI token statistics.

Responses

Production API

https://api.bitcoin.me/kfi-stats

Testnet API

https://api.staging.bitcoin.me/kfi-stats

Response samples

• 200

Content type

application/json

{

• "iconUrl": "string",
• "kfiPrice": "string",
• "abbr": "KFI",
• "assetId": "KFI"

}

Portfolio

Wallet portfolio and balances

Get Token Balances

Returns the token balances of an address.

path Parameters

address required

string Bech32 wallet address

Responses

Production API

https://api.bitcoin.me/balance/{address}

Testnet API

https://api.staging.bitcoin.me/balance/{address}

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "assetAbbr": "string",
  • "assetName": "string",
  • "assetId": "string",
  • "assetPrice": "string",
  • "amount": "string",
  • "amountInUSD": "string",
  • "iconURL": "string",
  • "precision": 0

  }

]

Get Full Portfolio

Returns the complete portfolio of an address, including pool positions and token balances.

path Parameters

address required

string Bech32 wallet address

Responses

Production API

https://api.bitcoin.me/portfolio/{address}

Testnet API

https://api.staging.bitcoin.me/portfolio/{address}

Response samples

• 200
• 400

Content type

application/json

{

• "portfolioOverview": {

  • "totalBalanceInUSD": "string",
  • "tokenBalancesInUSD": "string",
  • "poolBalancesInUSD": "string"

  },
• "positions": {

  • "Pool": {

    • "property1": {

      • "poolName": "string",
      • "scAddress": "string",
      • "assetId": "string",
      • "rewardAssetId": "string",
      • "assetAbbr": "string",
      • "iconURL": "string",
      • "firstTokenAmount": "string",
      • "firstTokenAmountInUSD": "string",
      • "firstTokenIconURL": "string",
      • "secondTokenAmount": "string",
      • "secondTokenAmountInUSD": "string",
      • "secondTokenIconURL": "string",
      • "amount": "string",
      • "amountInUSD": "string",
      • "unclaimedRewards": "string",
      • "unclaimedRewardsInUSD": "string",
      • "isClaimStakingRewardsEnable": true,
      • "apr": 0,
      • "minApr": 0,
      • "maxApr": 0,
      • "isUnbondToken": true,
      • "categoryType": "string"

      },
    • "property2": {

      • "poolName": "string",
      • "scAddress": "string",
      • "assetId": "string",
      • "rewardAssetId": "string",
      • "assetAbbr": "string",
      • "iconURL": "string",
      • "firstTokenAmount": "string",
      • "firstTokenAmountInUSD": "string",
      • "firstTokenIconURL": "string",
      • "secondTokenAmount": "string",
      • "secondTokenAmountInUSD": "string",
      • "secondTokenIconURL": "string",
      • "amount": "string",
      • "amountInUSD": "string",
      • "unclaimedRewards": "string",
      • "unclaimedRewardsInUSD": "string",
      • "isClaimStakingRewardsEnable": true,
      • "apr": 0,
      • "minApr": 0,
      • "maxApr": 0,
      • "isUnbondToken": true,
      • "categoryType": "string"

      }

    }

  },
• "tokenBalances": {

  • "Token": {

    • "property1": {

      • "assetAbbr": "string",
      • "assetName": "string",
      • "assetId": "string",
      • "assetPrice": "string",
      • "amount": "string",
      • "amountInUSD": "string",
      • "iconURL": "string",
      • "precision": 0,
      • "categoryType": "string"

      },
    • "property2": {

      • "assetAbbr": "string",
      • "assetName": "string",
      • "assetId": "string",
      • "assetPrice": "string",
      • "amount": "string",
      • "amountInUSD": "string",
      • "iconURL": "string",
      • "precision": 0,
      • "categoryType": "string"

      }

    },
  • "Locked": { }

  }

}

Get Close Position Data

Returns the data to close an LP position.

path Parameters

address required	string Bech32 wallet address
assetId required	string LP token Asset ID

Responses

Production API

https://api.bitcoin.me/portfolio/{address}/{assetId}/close

Testnet API

https://api.staging.bitcoin.me/portfolio/{address}/{assetId}/close

Response samples

• 200
• 400

Content type

application/json

{

• "poolName": "string",
• "scAddress": "string",
• "firstTokenAmount": "string",
• "secondTokenAmount": "string",
• "firstTokenAmountInUSD": "string",
• "secondTokenAmountInUSD": "string",
• "firstTokenIconURL": "string",
• "secondTokenIconURL": "string",
• "amount": "string",
• "amountInUSD": "string"

}

Rewards

Rewards status

Get Rewards Status

Returns the rewards status of an address.

path Parameters

address required

string Bech32 wallet address

Responses

Production API

https://api.bitcoin.me/rewards/{address}

Testnet API

https://api.staging.bitcoin.me/rewards/{address}

Response samples

• 200
• 400

Content type

application/json

{

• "isActive": true,
• "isUpdated": true,
• "isClaimEnabled": true

}

Energy

Energy management and positions

Get Energy and KFI Balances

Returns the energy and KFI balances of an address.

path Parameters

address required

string Bech32 wallet address

Responses

Production API

https://api.bitcoin.me/energy/{address}

Testnet API

https://api.staging.bitcoin.me/energy/{address}

Response samples

• 200
• 400

Content type

application/json

{

• "amount": "string",
• "kfiLocked": "string",
• "kfiAvailable": "string"

}

Get Energy Removal Penalty

Returns the penalty data for removing energy from a specific asset.

path Parameters

address required	string Bech32 wallet address
assetId required	string xKFI Asset ID
nonce required	string SFT nonce

Responses

Production API

https://api.bitcoin.me/energy/{address}/{assetId}/{nonce}/remove

Testnet API

https://api.staging.bitcoin.me/energy/{address}/{assetId}/{nonce}/remove

Response samples

• 200
• 400

Content type

application/json

{

• "removalFee": "string",
• "removalFeeInUSD": "string"

}

Get Multiple Energy Removal Penalties

Returns the penalty data for removing energy from multiple assets.

Request Body schema: application/json

required

address required	string Bech32 wallet address
assetIds required	Array of strings List of xKFI asset IDs

Responses

Production API

https://api.bitcoin.me/energy/remove

Testnet API

https://api.staging.bitcoin.me/energy/remove

Request samples

• Payload

Content type

application/json

{

• "address": "string",
• "assetIds": [

  • "string"

  ]

}

Response samples

• 200
• 400

Content type

application/json

{

• "penaltyEnergyData": [

  • {

    • "assetId": "string",
    • "removalFee": "string",
    • "removalFeeInUSD": "string"

    }

  ],
• "energyPositions": [

  • {

    • "assetId": "string",
    • "currentEnergy": "string",
    • "kfiLocked": "string",
    • "price": "string",
    • "charge": 0

    }

  ]

}

Get Energy Positions

Returns the user's energy positions.

path Parameters

address required

string Bech32 wallet address

Responses

Production API

https://api.bitcoin.me/energy-positions/{address}

Testnet API

https://api.staging.bitcoin.me/energy-positions/{address}

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "assetId": "string",
  • "currentEnergy": "string",
  • "kfiLocked": "string",
  • "price": "string",
  • "charge": 0

  }

]

Get Unlocked Tokens

Returns the user's unlocked tokens.

path Parameters

address required

string Bech32 wallet address

Responses

Production API

https://api.bitcoin.me/energy/unlocked-tokens/{address}

Testnet API

https://api.staging.bitcoin.me/energy/unlocked-tokens/{address}

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "unlockEpoch": 0,
  • "lockedTokens": {

    • "amount": 0,
    • "tokenIdentifier": "string",
    • "tokenNonce": 0

    },
  • "unlockedTokens": {

    • "amount": 0,
    • "tokenIdentifier": "string",
    • "tokenNonce": 0

    }

  }

]