Partner panel

PartnerApi backs the panel at . Everything it exposes is scoped to one partner: your keys, your orders, your referral earnings. It is a separate service from ApsisApi and uses session tokens rather than API keys.

Signing in

There is no password. Request a code by email, then exchange it for a session.

const { partner } = createApsisClient({ baseUrl: process.env.APSIS_API_URL!, token: () => session });

await partner.requestLoginCode({ email });

const created = await partner.verifyLoginCode({
  email,
  code: "123456",
  keepSignedIn: false,
});

created.token;       // send as: authorization: Bearer <token>
created.expiresAt;   // when it stops working

Rule	Value
Code lifetime	minutes
Wrong attempts before the code is discarded
Session lifetime	day
Session lifetime with `keep_signed_in`	days

Requesting codes in quick succession is throttled: a second request inside a minute is rejected rather than sending another email. Every other PartnerApi call needs the token in an authorization: Bearer header. An expired or unknown token returns UNAUTHENTICATED. Logout invalidates the session immediately.

API keys

const me = await partner.getPartner({});

me.email;
me.keys;      // existing keys
me.maxKeys;   // cap on active keys

RPC	Effect
`CreatePartnerApiKey`	Creates a named key and returns it, including the secret.
`RevokePartnerApiKey`	Revokes by id. Requests using it then fail as disabled.

The key value is returned on the key objects, so a partner can retrieve an existing key rather than rotating when it is misplaced. Treat it as a secret regardless: it carries your rate limit and your attribution. Key changes are cached briefly on the API side, so a new or revoked key takes a few seconds to take effect. See API keys.

Your orders

ListPartnerOrders returns orders attributed to your keys, newest first, cursor-paginated.

const page = await partner.listPartnerOrders({ limit: 50n });

for (const order of page.items) {
  order.quoteHash;
  order.state;
  order.srcChain;
  order.dstChain;
  order.depositAmount;
  order.depositSymbol;
  order.referrerFee;
  order.apiKeyName;   // which key originated it
}

api_key_name is what makes this useful across surfaces: issue one key per application and the attribution comes back for free.

Referrals and vouchers

RPC	Returns
`GetPartnerReferrals`	Claimable balances grouped by referrer, chain, and token.
`ClaimPartnerReferrer`	A signed voucher for one balance, marking its orders claimed.
`ListPartnerVouchers`	Every voucher issued to you, with redemption status.
`BuildVoucherRedemption`	A prepared redemption transaction for a voucher and payer.

See Referral program for what the voucher is and how redemption works on each chain.

Do not embed a partner session token in a client application. It grants key management and claiming. Sessions belong in the panel or in a backend you control.

Get started

Build a swap

Extend

Partner panel

Signing in

API keys

Your orders

Referrals and vouchers

​Signing in

​API keys

​Your orders

​Referrals and vouchers

Signing in

API keys

Your orders

Referrals and vouchers