Integration Guides

Points Integration

Partners integrating HyperFlow’s swap system can register a partner code so their users earn additional bonus points on every swap. For full parameter documentation, see the OpenAPI spec.

Points endpoints live on the platform API (api.hyperflow.fun), not on the aggregator hosts. No API key is required.

1

Get your partner code

Contact the HyperFlow team to receive your unique partner code (e.g. hyperflowteam) and agree on the bonus percentage users earn per swap via your integration (e.g. 10%).

2

Call the DEX Aggregator API with your code

When triggering a swap, call the DEX Aggregator API and pass your partner code in the source parameter:

$curl --location 'https://ag-api.hyperflow.fun/v1/hyperevm/swap?tokenIn=0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE&tokenOut=0x5d3a1Ff2b6BAb83b63cd9AD0787074081a52ef34&amountIn=50000000000000000&slippage=0.005&receiver=0xBc1E58631301a25ce1E4BF0677eF034882945597&source=hyperflowteam'
3

Estimate points before the swap

Before executing on-chain, call /v1/point/estimate (with your source code) to preview the points awarded:

$curl --location 'https://api.hyperflow.fun/v1/point/estimate?src_chain=hyperevm&src_token=0xB8CE59FC3717ada4C02eaDF9682A9e934F625ebb&src_usd=1&dst_chain=hyperevm&dst_token=0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE&dst_usd=1&from=1753014951&user=0x4b7CD6E52BBA5676096232538d34f16B375783ec&source=hyperflowteam'

Parameters (all required):

ParameterDescription
userWallet address of the trader
src_chain / dst_chainChain identifier (e.g. hyperevm)
src_token / dst_tokenToken addresses (native placeholder 0xEeee…EEeE for gas tokens)
src_usd / dst_usdUSD value of each side
fromUnix timestamp in seconds
sourceYour partner code

Example response:

1{
2  "point": 100,
3  "partnerBonus": 10
4}
  • point — base points from the transaction (excluding bonuses)
  • partnerBonus — additional points from your partner code
4

Execute the on-chain transaction

Perform the swap transaction as usual. The points logic is tied to your partner code, so your users’ actions accumulate bonus points automatically.

5

Verify credited points

Query GET https://api.hyperflow.fun/v1/point/leaderboard (query parameters user, from, to as unix-second integers; accepted ranges are enforced server-side — confirm details with the team) and navigate to total → pointPartnerBonuses → {your_code}:

1{
2  "total": {
3    "point": 100,
4    "pointPartnerBonuses": {
5      "hyperflowteam": 10
6    }
7  }
8}

This confirms points earned via your integration are credited under your partner code.

Need help?