Quickstart

AKKA’s partner API returns an exact-input quote, validation results, approval target, and ready-to-broadcast transaction in one call. This is the recommended flow for every new integration.

The shared basic-test-key below is only for evaluation. Keep a dedicated production apikey on a backend. Browser and mobile clients should call your own authenticated API route, which then calls AKKA.

Prerequisites

The shared basic-test-key for evaluation, or a dedicated partner key for production (request one)
A wallet with HYPE and gas on HyperEVM (chainId=999)
viem installed in your server-side project

Request an executable quote

Supply the address that pays for and sends the transaction as payer. recipient receives the output and can be a different address.

curl -G "https://api.akka.finance/partner/v1/999/quote" \
  -H "apikey: basic-test-key" \
  --data-urlencode "src=0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee" \
  --data-urlencode "dst=0xB8CE59FC3717ada4C02eaDF9682A9e934F625ebb" \
  --data-urlencode "amount=1000000000000000000" \
  --data-urlencode "payer=YOUR_WALLET_ADDRESS" \
  --data-urlencode "recipient=YOUR_WALLET_ADDRESS" \
  --data-urlencode "slippage=1"

The response includes buyAmount, minAmountOut, issues, validation, allowanceTarget, quote expiry, simulation status, and tx.

Resolve validation issues

A 200 response may contain actionable issues. Native input requires no approval. For ERC-20 input, approve allowanceTarget when the response contains INSUFFICIENT_ALLOWANCE.

import { erc20Abi } from 'viem';

const allowanceIssue = quote.issues.find(
  (issue) => issue.code === 'INSUFFICIENT_ALLOWANCE',
);

if (allowanceIssue && quote.allowanceTarget) {
  const approvalHash = await walletClient.writeContract({
    address: quote.sellToken,
    abi: erc20Abi,
    functionName: 'approve',
    args: [quote.allowanceTarget, BigInt(quote.sellAmount)],
  });
  await publicClient.waitForTransactionReceipt({ hash: approvalHash });

  // Approval changes state, so fetch a new executable quote.
  quote = await getPartnerQuote();
}

Do not broadcast while any validation check is UNKNOWN; verify it through your own RPC first.

Check freshness and submit

Execute immediately. Refresh if the current time is at or past expiresAt, or if simulation is not SUCCESS and your own simulation fails.

const feeFields =
  quote.tx.type === 'eip1559'
    ? {
        maxFeePerGas: BigInt(quote.tx.maxFeePerGas),
        maxPriorityFeePerGas: BigInt(quote.tx.maxPriorityFeePerGas),
      }
    : { gasPrice: BigInt(quote.tx.gasPrice) };

const hash = await walletClient.sendTransaction({
  to: quote.tx.to,
  data: quote.tx.data,
  value: BigInt(quote.tx.value),
  gas: BigInt(quote.tx.gas),
  ...feeFields,
});

const receipt = await publicClient.waitForTransactionReceipt({ hash });
console.log('Swap confirmed:', receipt.transactionHash);

Never edit tx.to, tx.data, or tx.value, and never reuse executable calldata.

Report the outcome

Outcome reporting is best-effort telemetry and helps AKKA identify route health problems.

curl -X POST "https://api.akka.finance/partner/v1/executions" \
  -H "apikey: basic-test-key" \
  -H "content-type: application/json" \
  -d '{
    "quoteId": "QUOTE_ID",
    "chainId": 999,
    "transactionHash": "0xTRANSACTION_HASH",
    "status": "CONFIRMED"
  }'

Getting Started

Guides

Resources

Prerequisites

Next steps

Complete TypeScript Example

Partner Quote Reference

​Prerequisites

​Next steps

Complete TypeScript Example

Partner Quote Reference

Prerequisites

Next steps