⚙️Swagger

API Playground

You can also find AKKA API swagger directly here :

Using AKKA APIs, you can find the best route to exchange assets and make the exchange.

Get quote for token swap

get

Find the best quote to exchange tokens via AKKA router. Returns expected output amount and optional token/protocol information.

Path parameters

chainintegerRequired

Blockchain chain ID (999=HyperEVM, 1116=Core, 50=XDC, 223=B2, 200901=Bitlayer, 4200=Merlin, 60808=BOB)

Example: 999

Query parameters

srcstringRequired

Source token contract address (use 0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee for native token)

Example: 0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee

dststringRequired

Destination token contract address

Example: 0xB8CE59FC3717ada4C02eaDF9682A9e934F625ebb

amountstringRequired

Amount to swap in wei (smallest unit)

Example: 1000000000000000000

includeTokensInfobooleanOptional

Include detailed token information in response

Default: falseExample: false

gasPricestringOptional

Network price per gas in wei

gasLimitstringOptional

Gas limit for the transaction

includeGasbooleanOptional

Include approximated gas in response

Default: falseExample: false

Responses

200

Quote retrieved successfully

application/json

400

Bad request - invalid parameters, token not found, or no route available

application/json

429

Too many requests - rate limit exceeded

500

Internal server error

get

/swap/v1/{chain}/quote

GET /swap/v1/{chain}/quote?src=0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee&dst=0xB8CE59FC3717ada4C02eaDF9682A9e934F625ebb&amount=1000000000000000000 HTTP/1.1
Host: api.akka.finance
Accept: */*

{
  "dstAmount": "205340622987446484992",
  "srcToken": {
    "address": "text",
    "symbol": "text",
    "name": "text",
    "decimals": 1,
    "logoUri": "text"
  },
  "dstToken": {
    "address": "text",
    "symbol": "text",
    "name": "text",
    "decimals": 1,
    "logoUri": "text"
  },
  "gas": 2419157
}

Generate swap transaction data

get

Generate complete transaction data for executing a token swap via AKKA router. Includes balance and allowance validation.

Path parameters

chainintegerRequired

Blockchain chain ID (999=HyperEVM, 1116=Core, 50=XDC, 223=B2, 200901=Bitlayer, 4200=Merlin, 60808=BOB)

Example: 999

Query parameters

srcstringRequired

Source token contract address (use 0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee for native token)

Example: 0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee

dststringRequired

Destination token contract address

Example: 0xB8CE59FC3717ada4C02eaDF9682A9e934F625ebb

amountstringRequired

Amount to swap in wei (smallest unit)

Example: 1000000000000000000

fromstringRequired

The address that calls the AKKA contract

Example: 0xD3C0F471488523b378F2D9C21939c97300c510F5

originstringRequired

An EOA address that initiates the transaction

Example: 0xD3C0F471488523b378F2D9C21939c97300c510F5

slippagenumber · max: 50Required

Maximum acceptable slippage percentage (min: 0; max: 50)

Example: 1

gasPricestringOptional

Network price per gas in wei

gasLimitnumberOptional

Gas limit for the transaction

includeTokensInfobooleanOptional

Return srcToken and dstToken info in response

Default: falseExample: false

includeGasbooleanOptional

Return approximated gas in response

Default: falseExample: false

Responses

200

Swap transaction data generated successfully

application/json

400

Bad request - insufficient balance/allowance, invalid parameters, or no route found

application/json

429

Too many requests - rate limit exceeded

500

Internal server error

get

/swap/v1/{chain}/swap

GET /swap/v1/{chain}/swap?src=0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee&dst=0xB8CE59FC3717ada4C02eaDF9682A9e934F625ebb&amount=1000000000000000000&from=0xD3C0F471488523b378F2D9C21939c97300c510F5&origin=0xD3C0F471488523b378F2D9C21939c97300c510F5&slippage=1 HTTP/1.1
Host: api.akka.finance
Accept: */*

{
  "dstAmount": "12723902882990271",
  "srcToken": {
    "address": "text",
    "symbol": "text",
    "name": "text",
    "decimals": 1,
    "logoUri": "text"
  },
  "dstToken": {
    "address": "text",
    "symbol": "text",
    "name": "text",
    "decimals": 1,
    "logoUri": "text"
  },
  "gas": 231973,
  "tx": {
    "from": "text",
    "to": "text",
    "data": "text",
    "value": "text",
    "gasPrice": "text",
    "gas": 1
  }
}

Get spender contract address for approvals

get

Returns the AKKA smart contract address that should be approved as a spender for token swaps on the specified chain.

Path parameters

chainintegerRequired

Blockchain chain ID (999=HyperEVM, 1116=Core, 50=XDC, 223=B2, 200901=Bitlayer, 4200=Merlin, 60808=BOB)

Example: 999

Responses

200

Spender address retrieved successfully

application/json

400

Bad request - invalid chain ID

application/json

429

Too many requests - rate limit exceeded

500

Internal server error

get

/swap/v1/{chain}/approve/spender

GET /swap/v1/{chain}/approve/spender HTTP/1.1
Host: api.akka.finance
Accept: */*

{
  "address": "0x7C5Af181D9e9e91B15660830B52f7B7076Be0d64"
}

Get approve transaction data

get

Generate transaction data to approve the AKKA Router to spend tokens. Returns the encoded transaction data that needs to be signed and sent by the user.

Path parameters

chainintegerRequired

Blockchain chain ID (999=HyperEVM, 1116=Core, 50=XDC, 223=B2, 200901=Bitlayer, 4200=Merlin, 60808=BOB)

Example: 999

Query parameters

tokenAddressstringRequired

Token address you want to approve for swapping

Example: 0xB8CE59FC3717ada4C02eaDF9682A9e934F625ebb

amountstringOptional

The number of tokens that the AKKA Router is allowed to swap. If not specified, it will be allowed to spend an infinite amount of tokens.

Example: 100000000000

Responses

200

Approve transaction data generated successfully

application/json

400

Bad request - invalid parameters

application/json

429

Too many requests - rate limit exceeded

500

Internal server error

get

/swap/v1/{chain}/approve/transaction

GET /swap/v1/{chain}/approve/transaction?tokenAddress=0xB8CE59FC3717ada4C02eaDF9682A9e934F625ebb HTTP/1.1
Host: api.akka.finance
Accept: */*

{
  "data": "0x095ea7b3000000000000000000000000111111125421ca6dc452d289314280a0f8842a65000000000000000000000000000000000000000000000000000000174876e800",
  "gasPrice": "100000000",
  "to": "0xB8CE59FC3717ada4C02eaDF9682A9e934F625ebb",
  "value": "0"
}

Get token allowance

get

Get the number of tokens that the AKKA Router is allowed to spend on behalf of a wallet address.

Path parameters

chainintegerRequired

Blockchain chain ID (999=HyperEVM, 1116=Core, 50=XDC, 223=B2, 200901=Bitlayer, 4200=Merlin, 60808=BOB)

Example: 999

Query parameters

tokenAddressstringRequired

Token address to check allowance for

Example: 0xB8CE59FC3717ada4C02eaDF9682A9e934F625ebb

walletAddressstringRequired

Wallet address to check the allowance for

Example: 0xD3C0F471488523b378F2D9C21939c97300c510F5

Responses

200

Allowance retrieved successfully

application/json

400

Bad request - invalid parameters

application/json

429

Too many requests - rate limit exceeded

500

Internal server error

get

/swap/v1/{chain}/approve/allowance

GET /swap/v1/{chain}/approve/allowance?tokenAddress=0xB8CE59FC3717ada4C02eaDF9682A9e934F625ebb&walletAddress=0xD3C0F471488523b378F2D9C21939c97300c510F5 HTTP/1.1
Host: api.akka.finance
Accept: */*

{
  "allowance": "0"
}

Get paginated token list

get

Retrieve a paginated list of tokens available for swap in the AKKA Finance ecosystem. Supports filtering by limit and page parameters for efficient data retrieval. Returns comprehensive token information including metadata, pricing, and verification status.

Path parameters

chainIdnumberRequired

Blockchain network identifier (999=HyperEVM, 1116=Core, 50=XDC, 223=B2, 200901=Bitlayer, 4200=Merlin, 60808=BOB)

Example: 999

Query parameters

pagenumberOptional

Page number for pagination (0-based)

limitnumberOptional

Number of tokens to return per page

Responses

200

Successfully retrieved paginated token list with comprehensive metadata including symbols, addresses, decimals, logos, and verification status

application/json

400

Invalid chain ID: must be a valid supported blockchain network identifier

500

Internal server error while fetching tokens

get

/{chainId}/tokens

GET /{chainId}/tokens HTTP/1.1
Host: api.akka.finance
Accept: */*

{
  "tokens": {
    "0x1f9840a85d5af5bf1d1762f925bdaddc4201f984": {
      "symbol": "UNI",
      "name": "Uniswap",
      "decimals": 18,
      "address": "0x1f9840a85d5af5bf1d1762f925bdaddc4201f984",
      "logoURI": "https://tokens.1inch.io/0x1f9840a85d5af5bf1d1762f925bdaddc4201f984.png",
      "tags": [
        "defi"
      ],
      "verified": true
    }
  }
}

Get token information by contract address

get

Retrieve detailed information about a specific token using its smart contract address. Returns comprehensive token data including symbol, name, decimals, logo URI, verification status, and trading metadata.

Path parameters

chainIdnumberRequired

Blockchain network identifier (999=HyperEVM, 1116=Core, 50=XDC, 223=B2, 200901=Bitlayer, 4200=Merlin, 60808=BOB)

Example: 999

addressstringRequired

Smart contract address of the token (checksummed EVM address format)

Example: 0xB8CE59FC3717ada4C02eaDF9682A9e934F625ebb

Responses

200

Successfully retrieved detailed token information including metadata and trading data

application/json

400

Invalid parameters: chain ID must be supported and token address must be a valid checksummed address

404

Token not found

500

Internal server error occurred while fetching token information from database or external sources

get

/{chainId}/tokens/{address}

GET /{chainId}/tokens/{address} HTTP/1.1
Host: api.akka.finance
Accept: */*

{
  "symbol": "UNI",
  "name": "Uniswap",
  "decimals": 18,
  "address": "0x1f9840a85d5af5bf1d1762f925bdaddc4201f984",
  "logoURI": "https://tokens.1inch.io/0x1f9840a85d5af5bf1d1762f925bdaddc4201f984.png",
  "tags": [
    "defi"
  ],
  "verified": true
}

API Welcome

get

Returns welcome message for AKKA Finance API

Responses

200

Welcome message

application/json

ResponsestringExample: Hello World!

get

GET / HTTP/1.1
Host: api.akka.finance
Accept: */*

200

Welcome message

Hello World!

Comprehensive Health Check

get

Check the health status of the API, database, Redis cache, and external APIs

Responses

200

The Health Check is successful

application/json

503

The Health Check is not successful

application/json

get

/health

GET /health HTTP/1.1
Host: api.akka.finance
Accept: */*

{
  "status": "ok",
  "info": {
    "database": {
      "status": "up"
    }
  },
  "error": {},
  "details": {
    "database": {
      "status": "up"
    }
  }
}

PreviousQuick start NextSmart Contracts

Last updated 1 day ago