REST API

The signature for creating an order can be either from an EVM or a Bitcoin wallet, regardless of the assets being traded. However, before an order containing a Bitcoin asset can be placed, a Bitcoin wallet must have been authorized; conversely, before an order containing an EVM asset can be placed, an EVM wallet must have been authorized. See the Authorize wallet API call below.

When signing an order with a fixed amount with an EVM wallet, create the signature by signing this EIP-712 message:

const message = {
  sender: address,
  baseChainId: baseChainId,
  baseToken: baseTokenAddress,
  quoteChainId: quoteChainId,
  quoteToken: quoteTokenAddress,
  amount: amount,
  price: price,
  nonce: Date.now()
}
const eip712 = {
  domain: {
    name: 'funkybit',
    chainId: chainId
  },
  types: {
    EIP712Domain: [
      { name: 'name', type: 'string' },
      { name: 'chainId', type: 'uint32' }
    ],
    'Order': [
      { name: 'sender', type: 'address' },
      { name: 'baseChainId', type: 'uint256' },
      { name: 'baseToken', type: 'address' },
      { name: 'quoteChainId', type: 'uint256' },
      { name: 'quoteToken', type: 'address' },
      { name: 'amount', type: 'int256' },
      { name: 'price', type: 'uint256' },
      { name: 'nonce', type: 'int256' }
    ]
  },
  message: message,
  primaryType: 'Order'
}

When signing an order with a percentage amount with an EVM wallet, create the signature by signing this EIP-712 message:

const message = {
  sender: address,
  baseChainId: baseChainId,
  baseToken: baseTokenAddress,
  quoteChainId: quoteChainId,
  quoteToken: quoteTokenAddress,
  percentage: percentage,
  price: price,
  nonce: Date.now()
}
const eip712 = {
  domain: {
    name: 'funkybit',
    chainId: chainId
  },
  types: {
    EIP712Domain: [
      { name: 'name', type: 'string' },
      { name: 'chainId', type: 'uint32' }
    ],
    'Order': [
      { name: 'sender', type: 'address' },
      { name: 'baseChainId', type: 'uint256' },
      { name: 'baseToken', type: 'address' },
      { name: 'quoteChainId', type: 'uint256' },
      { name: 'quoteToken', type: 'address' },
      { name: 'percentage', type: 'int256' },
      { name: 'price', type: 'uint256' },
      { name: 'nonce', type: 'int256' }
    ]
  },
  message: message,
  primaryType: 'Order'
}

When signing an order with a Bitcoin wallet, create the signature by signing a message constructed as follows:

const amountDescription = isPercentage ? `${amount}% of your` : amount
const swapDescription = isBuy ? `Swap ${amountDescription} ${quoteSymbol} for ${baseSymbol}` : `Swap ${amountDescription} ${baseSymbol} for ${quoteSymbol}`
const priceDescription = isLimit ? `Price: ${price}` : `Price: Market`
const message = `[funkybit] Please sign this message to authorize a swap. This action will not cost any gas fees.\n${swapDescription}\n${priceDescription}\nAddress: ${address}, Nonce: ${nonce}`

The bitcoin signature should be created following the same rules as for authentication.

The signature for cancelling an order can be either from an EVM or a Bitcoin wallet, regardless of the assets being traded.

When signing an order cancellation with an EVM wallet, create the signature by signing this EIP-712 message:

const message = {
  sender: address,
  marketId: marketId,
  amount: amount,
  nonce: Date.now()
}
const eip712 = {
  domain: {
    name: 'funkybit',
    chainId: chainId
  },
  types: {
    EIP712Domain: [
      { name: 'name', type: 'string' },
      { name: 'chainId', type: 'uint32' }
    ],
    'CancelOrder': [
      { name: 'sender', type: 'address' },
      { name: 'marketId', type: 'string' },
      { name: 'amount', type: 'int256' },
      { name: 'nonce', type: 'int256' }
    ]
  },
  message: message,
  primaryType: 'CancelOrder'
}

When signing an order cancellation with a Bitcoin wallet, create the signature by signing a message constructed as follows:

const swapDescription = isBuy ? `Swap ${amount} ${quoteSymbol} for ${baseSymbol}` : `Swap ${amount} ${baseSymbol} for ${quoteSymbol}`
const message = `[funkybit] Please sign this message to authorize order cancellation. This action will not cost any gas fees.\n${swapDescription}\nAddress: ${address}, Nonce: ${nonce}`

The bitcoin signature should be created following the same rules as for authentication.

When withdrawing an EVM asset, create the signature by signing this EIP-712 message (the chainId must be the correct one for the token being withdrawn):

const message = {
  sender: address,
  token: tokenAddress,
  amount: amount,
  nonce: Date.now()
}
const eip712 = {
  domain: {
    name: 'funkybit',
    chainId: chainId
  },
  types: {
    EIP712Domain: [
      { name: 'name', type: 'string' },
      { name: 'chainId', type: 'uint32' }
    ],
    'Withdraw': [
      { name: 'sender', type: 'address' },
      { name: 'token', type: 'address' },
      { name: 'amount', type: 'uint256' },
      { name: 'nonce', type: 'uint64' }
    ]
  },
  message: message,
  primaryType: 'Withdraw'
}

When withdrawing a Bitcoin asset, create the signature by signing this message:

const message = `[funkybit] Please sign this message to authorize withdrawal of ${amountInSats} ${symbol} from the exchange to your wallet.\nAddress: ${address}, Timestamp: ${new Date().toISOString()}`

The bitcoin signature should be created following the same rules as for authentication.

This is used to authorize a Bitcoin wallet for an existing EVM account, or to authorize an EVM wallet for an existing Bitcoin account. A given account can have at most 1 Bitcoin wallet and 1 EVM wallet. The wallet being added must not have already been added as either a primary or an additional wallet.

To authorize a Bitcoin wallet for an existing EVM wallet, sign this EIP-712 message (any valid chain id can be used):

const message = {
  message: `[funkybit] Please sign this message to authorize Bitcoin wallet ${authorizedAddress}. This action will not cost any gas fees.`,
  address: address.toLowercase(),
  authorizedAddress: authorizedAddress,
  chainId: chainId,
  timestamp: new Date().toISOString(),
}
const eip712 = {
  domain: {
    name: 'funkybit',
    chainId: chainId
  },
  types: {
    EIP712Domain: [
      { name: 'name', type: 'string' },
      { name: 'chainId', type: 'uint32' }
    ],
    'Authorize': [
      { name: 'message', type: 'string' },
      { name: 'address', type: 'string' },
      { name: 'authorizedAddress', type: 'string' },
      { name: 'chainId', type: 'uint32' },
      { name: 'timestamp', type: 'string' }
    ]
  },
  message: message,
  primaryType: 'Authorize'
}

To authorize an EVM wallet for an existing Bitcoin wallet, sign this message:

const message = `[funkybit] Please sign this message to authorize EVM wallet ${authorizedAddress.toLowerCase()}. This action will not cost any gas fees.\nAddress: ${address}, Timestamp: ${new Date().toISOString()}`

The bitcoin signature should be created following the same rules as for authentication.

PreviousWebsocket API

Last updated 1 month ago

POST /v1/batch/orders HTTP/1.1 Host: api.funkybit.fun Content-Type: application/json Accept: */* Content-Length: 720 { "marketId": "BTC/ETH", "createOrders": [ { "type": "limit", "nonce": "123", "marketId": "BTC/ETH", "side": "Buy", "amount": { "type": "fixed", "value": "100" }, "price": "100", "signature": "0x0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "signingAddress": "0x9a70C106F89a842246ebB328f6FBfF35a5987610", "verifyingChainId": "0" } ], "cancelOrders": [ { "orderId": "123", "marketId": "BTC/ETH", "side": "Buy", "amount": "100", "nonce": "123", "signature": "0x0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "signingAddress": "0x5a815285C0cC8a1750a0cc9dc27D65AAEACb4395", "verifyingChainId": "0" } ] }

{ "createdOrders": [ { "orderId": "order_01jwc9vzzjfpsscf77q251zaz3", "clientOrderId": null, "requestStatus": "Accepted", "error": null, "order": { "type": "market", "nonce": "123", "marketId": "BTC/ETH", "side": "Buy", "amount": { "type": "fixed", "value": "100" }, "signature": "0x0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "signingAddress": "0xB960F8eAeD8Fc6713E98bC65bDa72530457C4804", "verifyingChainId": "0" } }, { "orderId": "order_01jwc9vzzjfpsscf77q251zaz4", "clientOrderId": null, "requestStatus": "Accepted", "error": null, "order": { "type": "limit", "nonce": "123", "marketId": "BTC/ETH", "side": "Buy", "amount": { "type": "fixed", "value": "100" }, "price": "100", "signature": "0x0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "signingAddress": "0x9a70C106F89a842246ebB328f6FBfF35a5987610", "verifyingChainId": "0" } } ], "canceledOrders": [ { "orderId": "order_01jwc9vzzqfkjvz03z5pdxkvtm", "requestStatus": "Accepted", "error": null } ] }

POST /v1/coins/{coinName}/pools HTTP/1.1 Host: api.funkybit.fun Content-Type: application/json Accept: */* Content-Length: 386 { "feeRate": 500000, "initialTransfer": { "baseLiquidity": "0", "quoteLiquidity": "0", "tolerance": 100, "nonce": "", "signature": "0x0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "signingAddress": "0xAcAf390700be9e84015cead55b65d905F97359A1", "verifyingChainId": "0", "quoteLiquiditySymbol": "BTC" }, "name": "Pool Name" }

{ "pool": { "id": "01jwc9vzxke4ktgcxftz1vp6b3", "name": "Pool name", "feeRate": 500000, "baseSymbol": { "name": "DOG•GO•TO•THE•MOON:bitcoin", "description": "A description", "contractAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "decimals": 18, "faucetSupported": false, "iconUrl": "#", "withdrawalFee": "1", "chainId": "bitcoin", "chainName": "Bitcoin", "nameOnChain": "DOG•GO•TO•THE•MOON•ABCD" }, "quoteSymbol": { "name": "DOG•GO•TO•THE•MOON:bitcoin", "description": "A description", "contractAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "decimals": 18, "faucetSupported": false, "iconUrl": "#", "withdrawalFee": "1", "chainId": "bitcoin", "chainName": "Bitcoin", "nameOnChain": "DOG•GO•TO•THE•MOON•ABCD" }, "baseLiquidity": "0", "quoteLiquidity": "0", "accumulatedFee": "0", "tvl": "0", "h24Volume": "0", "h24Fees": "0", "h24Yield": "0", "d7Volume": "0", "d7Fees": "0", "d7Yield": "0", "createdAt": "2025-05-28T20:38:17.268941266Z" }, "initialTransferId": "lpt_01jwc9w05zegsvn2npyzyec95h" }

POST /v1/markets/amm HTTP/1.1 Host: api.funkybit.fun Content-Type: application/json Accept: */* Content-Length: 443 { "symbol": "AN•EXTERNAL•RUNE:bitcoin", "poolName": "Pool Name", "poolFeeRate": 500000, "initialLiquidityTransfer": { "baseLiquidity": "0", "quoteLiquidity": "0", "tolerance": 100, "nonce": "", "signature": "0x0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "signingAddress": "0xAcAf390700be9e84015cead55b65d905F97359A1", "verifyingChainId": "0", "quoteLiquiditySymbol": "BTC" } }

{ "market": { "id": "USDC/DAI", "baseSymbol": "USDC", "baseDecimals": 18, "quoteSymbol": "DAI", "quoteDecimals": 6, "tickSize": "0.01", "lastPrice": "0.995", "minFee": "1", "feeRate": "0", "type": "Clob" }, "pool": { "id": "01jwc9vzxke4ktgcxftz1vp6b3", "name": "Pool name", "feeRate": 500000, "baseSymbol": { "name": "DOG•GO•TO•THE•MOON:bitcoin", "description": "A description", "contractAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "decimals": 18, "faucetSupported": false, "iconUrl": "#", "withdrawalFee": "1", "chainId": "bitcoin", "chainName": "Bitcoin", "nameOnChain": "DOG•GO•TO•THE•MOON•ABCD" }, "quoteSymbol": { "name": "DOG•GO•TO•THE•MOON:bitcoin", "description": "A description", "contractAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "decimals": 18, "faucetSupported": false, "iconUrl": "#", "withdrawalFee": "1", "chainId": "bitcoin", "chainName": "Bitcoin", "nameOnChain": "DOG•GO•TO•THE•MOON•ABCD" }, "baseLiquidity": "0", "quoteLiquidity": "0", "accumulatedFee": "0", "tvl": "0", "h24Volume": "0", "h24Fees": "0", "h24Yield": "0", "d7Volume": "0", "d7Fees": "0", "d7Yield": "0", "createdAt": "2025-05-28T20:38:17.268941266Z" }, "initialTransferId": "lpt_01jwc9vzxne9wascxpvcr600fe" }

POST /v1/runes HTTP/1.1 Host: api.funkybit.fun Content-Type: application/json Accept: */* Content-Length: 503 { "name": "funkybit", "description": "", "icon": "data:image/svg+xml;base64,.....", "links": [ { "type": "Web", "url": "https://well-known.com/" } ], "args": { "type": "Basic", "initialOrder": { "nonce": "123", "amount": { "value": "100" }, "signature": "0x0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "signingAddress": "0x9b27a01D71a9c98CA82b8729C68258aFB269208a", "verifyingChainId": "0", "clientOrderId": "client-order-id", "adapterMarketId": null } } }

{ "coin": { "symbol": { "name": "DOG•GO•TO•THE•MOON:bitcoin", "description": "A description", "contractAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "decimals": 18, "faucetSupported": false, "iconUrl": "#", "withdrawalFee": "1", "chainId": "bitcoin", "chainName": "Bitcoin", "nameOnChain": "DOG•GO•TO•THE•MOON•ABCD" }, "createdBy": { "name": "User nickname", "userId": "123" }, "createdAt": "2025-05-28T20:38:17.417240596Z", "currentPrice": "1.23", "totalSupply": "1234567", "marketCap": "6500.00", "lastTradedAt": "2025-05-28T20:38:17.417260607Z", "progress": "43.5", "status": "BondingCurveAmm", "sequenceNumber": 1, "h24Volume": "0", "h24Change": "0", "d7Change": "0", "tvl": "0", "h24PoolVolume": "0", "h24PoolFees": "0", "h24MinPoolYield": "0", "h24MaxPoolYield": "0", "lastPoolCreatedAt": "2025-05-28T20:38:17.417267667Z", "links": [ { "type": "Web", "url": "https://example.com" } ] } }

Get account configuration

Mark symbol as added

Get balances

Get configuration

List deposits

Get deposit

Get last price for market

Get consumptions

Get order book

List orders

Cancel open orders

List trades

List withdrawals

Get withdrawal

Get Coin

Get Coin Activity

Get Coin Market

List coins

List pools

Get consumptions

List Fave Coins

Add coin to faves

Remove coin from faves

Get last price for market

Get My Portfolio

Get my positions

List eligible coins for pool creation

Get pool

Get portfolio value history with 1-day, and 7-day balances

Get rune wallet balance

Get external rune info

List User Coins

Get User Portfolio

Get user profile

Get wallet balance

Manage orders in batch

Deposit

Create order

Cancel order

Withdraw

Authorize wallet

Create liquidity pool

Set Avatar URL

Set Nickname

Create amm market

Add liquidity

Remove liquidity

Create rune

Import rune

Set ordinals address