Get an integration

Return one Borrow integration by id, with its networks and supported actions.

GET /v1/integrations/{integrationId}

Get integration details

cURL

curl --request GET \
  --url https://borrow.yield.xyz/v1/integrations/{integrationId} \
  --header 'x-api-key: <api-key>'

200

{
  "id": "aave-borrow",
  "providerId": "aave",
  "name": "Aave V3",
  "networks": [
    "ethereum",
    "polygon",
    "arbitrum"
  ],
  "metadata": {
    "description": "Aave is a decentralized non-custodial liquidity protocol for lending and borrowing.",
    "externalLink": "https://aave.com",
    "logoURI": "https://assets.stakek.it/protocols/aave.svg"
  },
  "actions": [
    {
      "id": "supply",
      "label": "Supply Collateral",
      "schema": {
        "type": "object",
        "properties": {
          "asset": {
            "type": "string",
            "label": "Asset",
            "pattern": "^0x[a-fA-F0-9]{40}$"
          },
          "amount": {
            "type": "string",
            "label": "Amount",
            "pattern": "^\\d+$"
          }
        },
        "required": [
          "network",
          "asset",
          "amount"
        ],
        "additionalProperties": false,
        "items": {
          "type": "string",
          "description": "<string>",
          "enum": [
            "long",
            "short"
          ],
          "default": {},
          "minimum": 123,
          "maximum": 123,
          "minLength": 123,
          "maxLength": 123,
          "pattern": "<string>",
          "items": "<unknown>",
          "properties": {},
          "required": [
            "<string>"
          ],
          "additionalProperties": {},
          "label": "Amount",
          "placeholder": "1000000",
          "optionsRef": "markets",
          "options": [
            "1",
            "2"
          ]
        },
        "enum": [
          "<string>"
        ],
        "default": {},
        "notes": "Supply assets to earn interest and optionally use as collateral for borrowing."
      }
    }
  ]
}

Same object as one element of List integrations. An unknown integrationId returns 404. Valid ids are listed in Integrations.

Authorizations

x-api-key · string · header · required

Path Parameters

integrationId · string · required

Integration identifier

Example:

"aave-borrow"

Response

200

application/json

Integration details

id · string · required

Integration identifier

Example:

"aave-borrow"

providerId · string · required

Provider identifier

Example:

"aave"

name · string · required

Integration display name

Example:

"Aave V3"

networks · enum<string>[] · required

Supported networks

Available options: ethereum, ethereum-goerli, ethereum-holesky, ethereum-sepolia, ethereum-hoodi, arbitrum, base, base-sepolia, gnosis, optimism, polygon, polygon-amoy, starknet, zksync, linea, unichain, plume, monad-testnet, monad, robinhood, robinhood-testnet, arc-testnet, arc, avalanche-c, avalanche-c-atomic, avalanche-p, binance, celo, fantom, harmony, moonriver, okc, viction, core, sonic, plasma, katana, hyperevm, tempo, pharos, agoric, akash, axelar, band-protocol, bitsong, canto, chihuahua, comdex, coreum, cosmos, crescent, cronos, cudos, desmos, dydx, evmos, fetch-ai, gravity-bridge, injective, irisnet, juno, kava, ki-network, mars-protocol, nym, okex-chain, onomy, osmosis, persistence, quicksilver, regen, secret, sentinel, sommelier, stafi, stargaze, stride, teritori, tgrade, umee, sei, mantra, celestia, saga, zetachain, dymension, humansai, neutron, polkadot, kusama, westend, bittensor, aptos, binancebeacon, cardano, near, solana, solana-devnet, stellar, stellar-testnet, sui, tezos, tron, ton, ton-testnet, hyperliquid

Example:

["ethereum", "polygon", "arbitrum"]

metadata · object · required

Integration metadata (description, logo, links)

Show child attributes

actions · object[] · required

Supported actions with labels and argument schemas

Show child attributes