Providers

Discover available providers, their capabilities, markets, and actions

​

getProviders

Returns all available providers, including their setup steps, trading actions, and categories.

import { createPerpsClient, getProviders } from '@lifi/perps-sdk';

const client = createPerpsClient({ integrator: 'my-app', apiKey: 'your-api-key' });
const { providers } = await getProviders(client);

for (const provider of providers.filter((p) => p.active)) {
  console.log(provider.key, provider.name);
  console.log('  categories:', provider.categories.map((c) => c.id));
  console.log('  actions:', provider.actions.map((a) => a.type));
}
// hyperliquid Hyperliquid
//   categories: ['hyperliquid', 'xyz', 'flx', 'spot', ...]
//   actions: ['placeOrder', 'cancelOrder', 'modifyOrder', ...]

​

Parameters

Parameter	Type	Required	Description
client	PerpsSDKClient	Yes	SDK client from createPerpsClient()
options	SDKRequestOptions	No	Request options — see SDKRequestOptions

​

Returns

ProvidersResponse — { providers: Provider[] }:

Each Provider:

Field	Type	Description
key	string	Unique provider identifier (used in query params)
name	string	Display name
shortName	string?	Short display name. A client shows this value in a compact place, and shows name when this value is absent.
logoURI	string	URL to provider logo image
referralCode	string?	LI.FI’s referral code for this provider, for use with the setReferrer setup action. Absent when not configured for the provider.
signingMethod	SigningMethod	Default signing method for the provider — see SigningMethod below.
active	boolean	When false, the provider is announced but not yet selectable in clients. Filter on this before rendering provider pickers.
setup	SetupAction[]	Account-setup steps in sequence order, with their signer, relay, options, and revoke. The user MUST satisfy every non-conditional step before trading. An empty array means the provider has no setup gates.
actions	ProviderAction[]	Trading/operational actions with their signer and relay
categories	ProviderCategory[]	Trading categories within the provider (e.g., hyperliquid, xyz, spot)
wsUrl	string?	WebSocket endpoint for streaming (see Streaming)
funding	ProviderFunding?	Provider-wide funding cadence in seconds: { ratePeriodSeconds, payoutCadenceSeconds }. Absent when the provider does not publish a global cadence.
minDepositUsd	string?	Minimum deposit amount in USD that the provider’s deposit path will accept, as a plain decimal string. Absent means no minimum is advertised.
minOrderValueUsd	string?	Minimum order notional value in USD, as a plain decimal string. Absent means no minimum is advertised.
minReduceOrderValueUsd	string?	Minimum order notional value in USD for reduce-only orders, as a plain decimal string, when the provider applies a lower floor than minOrderValueUsd. Absent means reduce-only orders use the same floor.
chainId	number?	Settlement chain id for the provider’s deposit/withdrawal path. Absent when not applicable.
minWithdrawalUsd	string?	Minimum withdrawal amount in USD the provider will accept, as a plain decimal string. Absent means no minimum is advertised.
depositFeeUsd	string?	Flat deposit fee in USD, as a plain decimal string, when the provider charges one.
withdrawalFeeUsd	string?	Flat withdrawal fee in USD, as a plain decimal string, when the provider charges one.
leveragePrecision	number?	Decimal places a client may use for leverage. Absent means integer leverage.
supportedIntervals	OhlcvInterval[]	OHLCV candle intervals the provider supports (e.g. 1m, 1h, 1d).

The API sends the five monetary amounts above as decimal strings. Parse each one before you compare or calculate with it. @lifi/perps-types@18.1.0 still declares the five fields number; that declaration disagrees with the live wire, and the next major of the package corrects it to DecimalString. Use the types in this table, not the published declaration.

Each ProviderCategory:

Field	Type	Description
id	string	Category identifier (referenced as categoryId in MarketRef)
logoURI	string?	URL to the category logo
quoteAsset	Asset | null	Quote asset for this category (null for the spot category, which has no single fixed quote)
tradeNotice	TradeNotice?	Optional advisory ({ level: 'info' | 'warn', message }) shown against the category’s markets

Each ProviderAction:

Field	Type	Description
type	ActionType	Action type string
signer	PerpsSigner	Who fulfils the step — see PerpsSigner below
signingMethod	SigningMethod	How the SDK must sign this action — see SigningMethod below. Most actions match the provider’s dominant pattern (Hyperliquid: eip712, Lighter: wasmBlob), but on-chain bridge actions like deposit are evmTx regardless of provider.
relay	ActionRelay	Where the signed step goes — see ActionRelay below

setup and actions share the ProviderAction shape. Which array an entry sits in carries the categorisation. Entries additionally populate the presentation and ordering fields a client renders:

Field	Type	Description
title	string?	Short user-facing label rendered in the modal
description	string?	One-paragraph explanation rendered under the title. For a choice step, the general prose for the whole choice.
docsUrl	string?	A link to the venue’s own documentation for the action. A UI can show it as a “Documentation” link.
params	Param[]?	Input descriptors the client collects before dispatching. Each Param describes one input; its values array enumerates the legal value strings the action accepts. A choice step declares no params.
sequence	number?	Ascending order in which the user satisfies setup steps (lower runs first)
gatesAccountReads	boolean?	true marks the step whose satisfaction lets the venue authenticate account reads and account streams for the address. Only true is a gate marker: false and absent both mean the step gates nothing.

​

SetupAction

Each setup entry is a SetupAction: a ProviderAction with two extra fields. Both fields are always present.

Field	Type	Description
options	SetupOption[] | null	The selectable options when the step is a choice. null when the step is not a choice. A choice step declares no params.
revoke	ActionType | null	The actions entry that undoes the satisfied step. null when a satisfied step cannot be undone.

interface SetupOption<T extends ActionType = ActionType> {
  title: string;
  description?: string; // the option's own prose
  type: T; // the action that applies the option
  params: ActionParamsMap[T]; // the action params, already bound
  default?: true; // the recommended option
}

options holds the choices, and default marks the recommended one. At most one option of a step has default. The SDK never executes the recommended option on its own. Pass the option the user picked to executeProviderOption(). Use isSetupOptionFor(option, ActionType.ACCOUNT_TYPE) to narrow an option to the params of its action.

The /providers response carries no provider-level options property.

​

PerpsSigner

Who fulfils a step. Surfaced per action in ProviderAction.signer.

Value	Description
USER	The user’s wallet or consent must act. Usually this invokes the wallet; client-only session setup steps can instead use the provider session established by the user’s SIWE login.
SDK	The SDK fulfils the step with its own credentials. Depending on the venue this can be an approved agent key, a Lighter native signing key, an HMAC key, or a provider session. Consumers do not select a credential subtype.

​

ActionRelay

Where a signed step goes. Surfaced per action in ProviderAction.relay.

Value	Description
API	Submit the signed step to POST /executeAction. For EVM_TX (Lighter DEPOSIT), the user’s wallet broadcasts each leg, and the signed steps that carry txHash go to /executeAction as the acknowledgement.
CLIENT	The client submits the step to the venue itself. Nothing reaches LI.FI.

​

SigningMethod

Identifies how an action is authorized. The SDK uses this to dispatch to the provider-owned signing path. The wire-level values are camelCase strings exposed by the SigningMethod enum.

Wire value	SigningMethod key	Description
eip712	EIP712	EIP-712 typed data + ECDSA signature
wasmBlob	WASM_BLOB	Opaque provider transaction blob signed through a WASM signer
evmTx	EVM_TX	Plain EVM transaction
hmac	HMAC	Per-request HMAC generated SDK-side from a client-held API key
siwe	SIWE	ERC-4361 login challenge signed with personal_sign
session	SESSION	Client-only venue request authorized by a provider session; no executeAction submission

Use provider.setup to build the setup UI, with options for each choice. See Hyperliquid / Setup for the full flow. The SDK is the supported integration path. If you call the API without it, see Integrating without the SDK.

​

SDKRequestOptions

Every service function takes an optional final options argument of type SDKRequestOptions:

Field	Type	Description
signal	AbortSignal?	Aborts the request and any pending backoff delay

​

Deposit Flow Discovery

PerpsClient.getDepositFlow({ provider, address }) asks the registered provider plugin how that account must be funded. It returns undefined when the plugin declares no deposit flow, otherwise one of three discriminated variants:

kind	Fields	Meaning
lifiSwap	destination, optional toAddress	Route through LI.FI into the exact collateral asset; toAddress is present for a provider-provisioned destination
venueDepositPipeline	chainId, gasAsset, collateral, bridgeAction: ActionType.DEPOSIT	Seed gas and collateral on the venue chain, then execute the venue deposit action. The action credits the account, and opens it when none exists
setupRequired	setup: ActionType[]	Complete the listed setup actions in order before the provider can name a deposit destination

const flow = await perps.getDepositFlow({
  provider: 'lighter-rh',
  address: userAddress,
});

if (flow?.kind === 'venueDepositPipeline') {
  console.log(flow.chainId, flow.gasAsset, flow.collateral);
}

A DeclaredDepositAsset is identified by { chainId, address, decimals }. Do not infer token identity from its symbol.

​

Executing a deposit flow

How to move funds depends on the flow kind:

Flow	Rule
lifiSwap without toAddress	Route into flow.destination through LI.FI; the funds land in the account’s own venue balance.
lifiSwap with toAddress	Route into flow.destination with toAddress as the LI.FI quote recipient, not the user’s own address. If the source token and chain already equal flow.destination, there is nothing to swap or bridge and LI.FI cannot quote the route: send a plain ERC-20 transfer of that token to toAddress instead.
venueDepositPipeline	Walk the stages in order: (1) native gas, the flow.gasAsset on flow.chainId (see getGasRecommendation); (2) flow.collateral, by routing into it through LI.FI when the wallet does not hold it; (3) execute ActionType.DEPOSIT with { amount, tokenAddress, chainId }, where amount is an integer string in the token’s base units.
setupRequired	Complete flow.setup first, then read the flow again.

Each on-chain leg is broadcast on its own chain. The wallet must be on that chain, or the client must have a switchChain hook configured; a leg whose target chain differs from the wallet’s chain throws before broadcasting. When a balance needed to choose the next stage cannot be read, do not guess a stage.

---

API Reference: GET /providers