Quickstart

This is a guide on how to get started using the API in an instant.

You can use tools like Postman or Curl to send GET requests to the main endpoint (querying AURA for strategies), by substituting the address parameter with any EVM network wallet address.

Example request using Curl

curl -X GET "https://aura.adex.network/api/portfolio/strategies?address=0x48Bdaa967c99f5f81430E94064B27a4917055f35"

This request will query AURA for this wallet address, meaning that it will fetch its on-chain portfolio, analyze user's risk profile and output relevant investment strategies.

Example response

• Status Code: 200 OK

• Content Type: application/json

• Response Body:

• {
    "address": "0x48Bdaa967c99f5f81430E94064B27a4917055f35",
    "portfolio": [
      {
        "network": {
          "name": "Ethereum",
          "chainId": "1",
          "platformId": "ethereum",
          "explorerUrl": "https://etherscan.io",
          "iconUrls": []
        },
        "tokens": [
          {
            "symbol": "stkWALLET",
            "balance": 418743.015,
            "balanceUSD": 6324.65,
            "network": "Ethereum",
            "address": "0xE575cC6EC0B5d176127ac61aD2D3d9d19d1aa4a0"
          },
          {
              "symbol": "ETH",
              "balance": 0.033414660038225026,
              "balanceUSD": 92.84530608901129,
              "network": "Ethereum",
              "address": "0x0000000000000000000000000000000000000000"
          }
          ...
        ]
      },
      ...
    ],
    "strategies": [
      {
        "llm": {
          "provider": "AdEx Aura",
          "model": "adex-aura-0.2"
        },
        "response": [
          {
            "name": "Low Risk Stablecoin Yield",
            "risk": "low",
            "actions": [
              {
                "apy": "2-5%",
                "description": "Deposit USDC on Aave on the Base network...",
                "networks": ["base"],
                "operations": ["lending"],
                "platforms": [
                  {
                    "name": "Aave",
                    "url": "https://app.aave.com/"
                  }
                ],
                "tokens": "USDC"
              },
              ...
            ],
          },
          ...
        ],
        "error": null,
        ...
      },
      ...
    ],
    "cached": false,
    "version": "0.2.6"
  }

For a more detailed reference to using the API, please check the documentation that follows.