De.Fi

https://docs.de.fi
Admin
De.Fi is a platform dedicated to making the Web3 financial revolution accessible and secure for...
Tokens:17,439
Snippets:95
Trust Score:9.4
Update:1 year ago
Show doc for...
Tokens:
Raw
### Node.js SDK

Source: https://docs.de.fi/api/api

Information on how to install and use the De-Fi Node.js SDK to facilitate API usage.

```APIDOC
## Node.js SDK

The De-Fi API provides an SDK for Node.js environments.

### Installation

```bash
npm i @de-fi/sdk
```

### Documentation

SDK documentation can be found [here](https://www.npmjs.com/package/@de-fi/sdk).
```

--------------------------------

### Get Supported Chains (GraphQL)

Source: https://docs.de.fi/api/api

Retrieves a list of all chains supported by the De.Fi platform. This is a foundational call for many other De.Fi API operations.

```graphql
query {
  chains  {
    id
    name
  }
}
```

--------------------------------

### Get Farms and Opportunities (GraphQL)

Source: https://docs.de.fi/api/api

Allows fetching information about De.Fi's Explore Yield feature. `opportunityFarms` retrieves all supported platforms and features, while `opportunities` lists available yield opportunities, with filtering options by platform, feature, and chain.

```graphql
query {
  opportunityFarms
}
```

```graphql
query {
  opportunities(filter: { chain: "1" }) 
}
```

--------------------------------

### Get Protocols (GraphQL)

Source: https://docs.de.fi/api/api

Retrieves a list of supported protocols by De.Fi. It supports fetching V2 protocols (TOP EVM) and V1 protocols for other platforms, including non-EVM chains. The V2 endpoint list is expanding.

```graphql
query {
  protocols (version: V2) {
    name
    slug
    features {
      list 
    }
  }
}
query {
  protocols (version: V1) {
    name
    slug
    features {
      list 
    }
  }
}
```

--------------------------------

### Get Protocol Balances V2 (GraphQL)

Source: https://docs.de.fi/api/api

Fetches user positions and balances for top De.Fi supported platforms (primarily EVM). It requires chain IDs and wallet addresses as input and returns errors, balances, and protocol information.

```graphql
query {
  protocolBalanceV2 (
    chainIds: [1,2]
    walletAddresses:["...wallet #1...", "...wallet #2..."]
  ){
    errors
    balances {
      protocol {
        slug 
      }
      address
      total
    }

  }
}
```

--------------------------------

### Get Asset Balances (GraphQL)

Source: https://docs.de.fi/api/api

Fetches ERC20 token balances for specified wallet addresses on EVM chains, or general asset balances for non-EVM chains. It returns the total balance and associated chain information.

```graphql
query {
  assetBalancesAdvanced(
    chainIds: [1, 2]
    walletAddresses: ["...wallet #1...", "...wallet #2..."])
    {
    total
    wallet
    chains {
      chain {
        id
      }
    }
  }
}
```

```graphql
query {
  assetBalances(chainIds: [1, 2], walletAddresses: ["...wallet #1...", "...wallet #2..."]) {
    total
    wallet
    chains {
      chain {
        id
      }
    }
  }
}
```

--------------------------------

### Get Scanner Liquidity Information (GraphQL)

Source: https://docs.de.fi/api/api

Retrieves liquidity information for specific tokens. This endpoint helps assess the tradability and potential slippage for tokens, often used after identifying tokens of interest.

```graphql
query {
  scannerLiquidityAnalysis(tokenAddresses: ["0x..."]) {
    address
    totalLiquidity
    providers
  }
}
```

--------------------------------

### Get Scanner Project Security Analysis (GraphQL)

Source: https://docs.de.fi/api/api

Performs advanced security analysis on smart contracts. This endpoint is typically used with contract addresses obtained from security-related calls, providing in-depth security insights.

```graphql
query {
  scannerProject(contractAddresses: ["0x..."]) {
    address
    securityScore
    vulnerabilities
  }
}
```

--------------------------------

### Get Shield Approvals (GraphQL)

Source: https://docs.de.fi/api/api

Retrieves all token approvals granted by a specific wallet address. This is a crucial step in the security dashboard's workflow to identify potential risks.

```graphql
query {
  shieldApprovals(walletAddress: "0x...") {
    tokenAddress
    spender
    amount
  }
}
```

--------------------------------

### Get Scanner Holder Information (GraphQL)

Source: https://docs.de.fi/api/api

Provides detailed holder information for specific tokens. This endpoint is used in conjunction with token addresses obtained from previous security or asset balance calls to understand token distribution.

```graphql
query {
  scannerHolderAnalysis(tokenAddresses: ["0x..."]) {
    address
    holderCount
    topHolders
  }
}
```

--------------------------------

### Get Protocol Balance (GraphQL)

Source: https://docs.de.fi/api/api

Retrieves user positions and balances for a specific protocol, chain, and wallet address. This is used for platforms not covered by the V2 endpoint, including non-EVM chains. It returns protocol details, total balance, and chain-specific totals.

```graphql
query {
  protocolBalance ( balances: {
    chainIds: [1]
    walletAddress: "...wallet..."
    protocolName: "Arrakis"
  } )
  {
    protocol {
      slug
    }
    total
    chains {
      total
    }
  }
}
```

--------------------------------

### Portfolio Dashboard: Protocols

Source: https://docs.de.fi/api/api

Fetches supported protocols, with V2 for TOP EVM and V1 for others.

```APIDOC
## POST /graphql

### Description
Retrieves a list of supported protocols. Use `version: V2` for top EVM platforms and `version: V1` for others, including non-EVM chains.

### Method
POST

### Endpoint
/graphql

### Parameters
#### Query Parameters
- **query** (String) - Required - The GraphQL query string.

#### Request Body
- **version** (Enum: `V1`, `V2`) - Required - Specifies the version of protocols to fetch.

### Request Example
```json
{
  "query": "query { protocols (version: V2) { name slug features { list } } }"
}
```

### Response
#### Success Response (200)
- **data** (Object) - The response data.
  - **protocols** (Array) - A list of protocol objects.
    - **name** (String) - The name of the protocol.
    - **slug** (String) - The unique slug for the protocol.
    - **features** (Object)
      - **list** (Array[String]) - A list of features offered by the protocol.

#### Response Example
```json
{
  "data": {
    "protocols": [
      {
        "name": "Aave",
        "slug": "aave",
        "features": {
          "list": ["Lending", "Borrowing"]
        }
      }
    ]
  }
}
```
```

--------------------------------

### Portfolio Dashboard: Chains

Source: https://docs.de.fi/api/api

Fetches all supported chains by De.Fi.

```APIDOC
## GET /graphql

### Description
Retrieves a list of all chains supported by the De.Fi platform.

### Method
POST

### Endpoint
/graphql

### Parameters
#### Query Parameters
- **query** (String) - Required - The GraphQL query string.

### Request Example
```json
{
  "query": "query { chains { id name } }"
}
```

### Response
#### Success Response (200)
- **data** (Object) - The response data containing a list of chains.
  - **chains** (Array) - A list of chain objects.
    - **id** (Int) - The unique identifier for the chain.
    - **name** (String) - The name of the chain.

#### Response Example
```json
{
  "data": {
    "chains": [
      { "id": 1, "name": "Ethereum" },
      { "id": 2, "name": "Polygon" }
    ]
  }
}
```
```

--------------------------------

### Portfolio Endpoints

Source: https://docs.de.fi/api/api

Endpoints for querying wallet balances, protocol interactions, and DeFi portfolio data.

```APIDOC
## POST /graphql (assetBalances)

### Description
Retrieves ERC20 token balances for a given wallet address. This endpoint provides a snapshot of a user's token holdings on supported blockchains.

### Method
POST

### Endpoint
`https://public-api.de.fi/graphql`

### Parameters
#### Request Body
- **query** (string) - Required - The GraphQL query string for asset balances.
- **variables** (object) - Required - Variables including `address` and `chain_id`.
  - **address** (string) - Required - The wallet address to query.
  - **chain_id** (integer) - Required - The ID of the blockchain (use values from the `chains` endpoint).

### Request Example
```json
{
  "query": "query GetAssetBalances($address: String!, $chain_id: Int!) { assetBalances(address: $address, chain_id: $chain_id) { id, balance, token { name, symbol, decimals, derivedEth } } }",
  "variables": {
    "address": "0xYourWalletAddressHere",
    "chain_id": 1 
  }
}
```

### Response
#### Success Response (200)
- **data.assetBalances** (array) - A list of token balance objects for the specified wallet address.
  - **id** (string) - Unique identifier for the balance entry.
  - **balance** (string) - The balance of the token (as a string, potentially large number).
  - **token** (object) - Information about the token.
    - **name** (string) - The name of the token.
    - **symbol** (string) - The symbol of the token.
    - **decimals** (integer) - The number of decimal places for the token.
    - **derivedEth** (string) - The value of the token in ETH.

#### Response Example
```json
{
  "data": {
    "assetBalances": [
      {
        "id": "eth-balance-id",
        "balance": "1500000000000000000",
        "token": {
          "name": "Ethereum",
          "symbol": "ETH",
          "decimals": 18,
          "derivedEth": "1.0"
        }
      },
      {
        "id": "dai-balance-id",
        "balance": "500000000000000000000",
        "token": {
          "name": "Dai Stablecoin",
          "symbol": "DAI",
          "decimals": 18,
          "derivedEth": "0.0003"
        }
      }
    ]
  }
}
```
```

```APIDOC
## POST /graphql (assetBalancesAdvanced)

### Description
(BETA) Retrieves ERC20 token balances for multiple wallet addresses and chains in a single request. This is an advanced version for batch processing.

### Method
POST

### Endpoint
`https://public-api.de.fi/graphql`

### Parameters
#### Request Body
- **query** (string) - Required - The GraphQL query string for advanced asset balances.
- **variables** (object) - Required - Variables including `addresses` (array) and `chains` (array).
  - **addresses** (array of strings) - Required - A list of wallet addresses to query.
  - **chains** (array of integers) - Required - A list of chain IDs to query for each address.

### Request Example
```json
{
  "query": "query GetAssetBalancesAdvanced($addresses: [String!]!, $chains: [Int!]!) { assetBalancesAdvanced(addresses: $addresses, chains: $chains) { address, chain_id, balance, token { name, symbol, decimals, derivedEth } } }",
  "variables": {
    "addresses": ["0xWalletAddress1", "0xWalletAddress2"],
    "chains": [1, 2] 
  }
}
```

### Response
#### Success Response (200)
- **data.assetBalancesAdvanced** (array) - A list of token balance objects across multiple addresses and chains.
  - **address** (string) - The wallet address associated with the balance.
  - **chain_id** (integer) - The ID of the blockchain.
  - **balance** (string) - The balance of the token.
  - **token** (object) - Information about the token (same as `assetBalances`).

#### Response Example
```json
{
  "data": {
    "assetBalancesAdvanced": [
      {
        "address": "0xWalletAddress1",
        "chain_id": 1,
        "balance": "1500000000000000000",
        "token": {
          "name": "Ethereum",
          "symbol": "ETH",
          "decimals": 18,
          "derivedEth": "1.0"
        }
      },
      {
        "address": "0xWalletAddress1",
        "chain_id": 2,
        "balance": "2000000000000000000",
        "token": {
          "name": "Wrapped BNB",
          "symbol": "WBNB",
          "decimals": 18,
          "derivedEth": "0.04"
        }
      }
    ]
  }
}
```
```

```APIDOC
## POST /graphql (protocols)

### Description
Retrieves information about the decentralized applications (dApps) and protocols integrated into the De.Fi dashboard. Includes a link to the full list of supported protocols.

### Method
POST

### Endpoint
`https://public-api.de.fi/graphql`

### Parameters
#### Request Body
- **query** (string) - Required - The GraphQL query string for protocols.

### Request Example
```json
{
  "query": "{ protocols { id, name, logo, website, twitter, tvl } }"
}
```

### Response
#### Success Response (200)
- **data.protocols** (array) - A list of protocol objects.
  - **id** (string) - Unique identifier for the protocol.
  - **name** (string) - The name of the protocol.
  - **logo** (string) - URL of the protocol's logo.
  - **website** (string) - The official website of the protocol.
  - **twitter** (string) - The Twitter handle of the protocol.
  - **tvl** (string) - The Total Value Locked (TVL) in the protocol.

#### Response Example
```json
{
  "data": {
    "protocols": [
      {
        "id": "uniswap-v3",
        "name": "Uniswap V3",
        "logo": "https://logos.de.fi/uniswap.png",
        "website": "https://uniswap.org",
        "twitter": "@Uniswap",
        "tvl": "10000000000"
      }
    ]
  }
}
```
```

```APIDOC
## POST /graphql (protocolBalanceV2)

### Description
(BETA) Retrieves protocol balances for a given wallet address across multiple chains. Allows fetching data for multiple addresses and chains in a single request.

### Method
POST

### Endpoint
`https://public-api.de.fi/graphql`

### Parameters
#### Request Body
- **query** (string) - Required - The GraphQL query string for protocol balance V2.
- **variables** (object) - Required - Variables including `addresses` (array) and `chains` (array).
  - **addresses** (array of strings) - Required - A list of wallet addresses to query.
  - **chains** (array of integers) - Required - A list of chain IDs to query for each address.

### Request Example
```json
{
  "query": "query GetProtocolBalancesV2($addresses: [String!]!, $chains: [Int!]!) { protocolBalanceV2(addresses: $addresses, chains: $chains) { address, chain_id, protocol { name }, balance, asset { name, symbol } } }",
  "variables": {
    "addresses": ["0xYourWalletAddressHere"],
    "chains": [1, 137] 
  }
}
```

### Response
#### Success Response (200)
- **data.protocolBalanceV2** (array) - A list of protocol balance objects.
  - **address** (string) - The wallet address.
  - **chain_id** (integer) - The ID of the blockchain.
  - **protocol** (object) - Information about the protocol.
    - **name** (string) - The name of the protocol.
  - **balance** (string) - The balance amount.
  - **asset** (object) - Information about the asset.
    - **name** (string) - The name of the asset.
    - **symbol** (string) - The symbol of the asset.

#### Response Example
```json
{
  "data": {
    "protocolBalanceV2": [
      {
        "address": "0xYourWalletAddressHere",
        "chain_id": 1,
        "protocol": {
          "name": "Aave V2"
        },
        "balance": "1000000000000000000",
        "asset": {
          "name": "Aave Token",
          "symbol": "AAVE"
        }
      }
    ]
  }
}
```
```

```APIDOC
## POST /graphql (protocolBalance)

### Description
Retrieves protocol balances for a given wallet address. This endpoint provides details on a user's interactions and holdings within specific DeFi protocols.

### Method
POST

### Endpoint
`https://public-api.de.fi/graphql`

### Parameters
#### Request Body
- **query** (string) - Required - The GraphQL query string for protocol balance.
- **variables** (object) - Required - Variables including `address` and `chain_id`.
  - **address** (string) - Required - The wallet address to query.
  - **chain_id** (integer) - Required - The ID of the blockchain (use values from the `chains` endpoint).

### Request Example
```json
{
  "query": "query GetProtocolBalance($address: String!, $chain_id: Int!) { protocolBalance(address: $address, chain_id: $chain_id) { id, protocol { name }, balance, asset { name, symbol } } }",
  "variables": {
    "address": "0xYourWalletAddressHere",
    "chain_id": 1 
  }
}
```

### Response
#### Success Response (200)
- **data.protocolBalance** (array) - A list of protocol balance objects for the specified wallet address.
  - **id** (string) - Unique identifier for the balance entry.
  - **protocol** (object) - Information about the protocol.
    - **name** (string) - The name of the protocol.
  - **balance** (string) - The balance amount.
  - **asset** (object) - Information about the asset.
    - **name** (string) - The name of the asset.
    - **symbol** (string) - The symbol of the asset.

#### Response Example
```json
{
  "data": {
    "protocolBalance": [
      {
        "id": "aave-v2-balance-id",
        "protocol": {
          "name": "Aave V2"
        },
        "balance": "1000000000000000000",
        "asset": {
          "name": "Aave Token",
          "symbol": "AAVE"
        }
      }
    ]
  }
}
```
```

--------------------------------

### Portfolio Dashboard: Protocol Balance V2

Source: https://docs.de.fi/api/api

Fetches user positions and balances for top supported De.Fi platforms.

```APIDOC
## POST /graphql

### Description
Retrieves user positions and balances for the top platforms supported by De.Fi using version 2 of the protocol balance endpoint.

### Method
POST

### Endpoint
/graphql

### Parameters
#### Query Parameters
- **query** (String) - Required - The GraphQL query string.

#### Request Body
- **chainIds** (Array[Int]) - Required - A list of chain IDs.
- **walletAddresses** (Array[String]) - Required - A list of wallet addresses.

### Request Example
```json
{
  "query": "query { protocolBalanceV2 (chainIds: [1,2], walletAddresses: [\"...wallet #1...\", \"...wallet #2\"]) { errors balances { protocol { slug } address total } } }"
}
```

### Response
#### Success Response (200)
- **data** (Object) - The response data.
  - **protocolBalanceV2** (Object)
    - **errors** (Array) - A list of errors encountered during the query.
    - **balances** (Array) - A list of balance objects.
      - **protocol** (Object)
        - **slug** (String) - The protocol's unique slug.
      - **address** (String) - The wallet address associated with the balance.
      - **total** (Float) - The total balance for the protocol.

#### Response Example
```json
{
  "data": {
    "protocolBalanceV2": {
      "errors": [],
      "balances": [
        {
          "protocol": { "slug": "aave" },
          "address": "...wallet #1...",
          "total": 500.50
        }
      ]
    }
  }
}
```
```

--------------------------------

### API Pricing and Rate Limits

Source: https://docs.de.fi/api/api

This section details the credit cost and rate limits for various endpoints when using the DeFi API. It is necessary to purchase credits to make queries.

```APIDOC
## API Pricing & Rate Limits

To make queries with the API key, credits must be purchased. The credit cost depends on the complexity of the queries.

### Endpoints Overview

| Endpoint                 | Credit Cost | Rate Limit (per minute) |
| ------------------------ | ----------: | ----------------------: |
| assetBalances            |          10 |                      20 |
| assets                   |           1 |                     100 |
| assetsPrices             |           1 |                     100 |
| chains                   |           1 |                     100 |
| credits                  |           1 |                     100 |
| opportunities            |           3 |                     100 |
| opportunityFarms         |           1 |                     100 |
| protocolBalance          |          10 |                      20 |
| protocols                |           1 |                     100 |
| rekts                    |           3 |                     100 |
| shields                  |          10 |                      20 |
| shieldApprovals          |          10 |                      20 |
| shieldApprovalsNft       |           5 |                      20 |
| shieldAdvanced           |           5 |                      20 |
| scannerLiquidityAnalysis |          10 |                      20 |
| scannerHolderAnalysis    |           5 |                      20 |
| scannerProject           |          25 |                      20 |
```

--------------------------------

### Portfolio Dashboard: Protocol Balance

Source: https://docs.de.fi/api/api

Fetches user positions and balances for other supported De.Fi platforms, including non-EVM chains.

```APIDOC
## POST /graphql

### Description
Retrieves user positions and balances for remaining De.Fi supported platforms, including non-EVM chains. This endpoint requires specifying balances per chain, wallet, and protocol combination.

### Method
POST

### Endpoint
/graphql

### Parameters
#### Query Parameters
- **query** (String) - Required - The GraphQL query string.

#### Request Body
- **balances** (Object) - Required - Object containing balance details.
  - **chainIds** (Array[Int]) - Required - A list of chain IDs.
  - **walletAddress** (String) - Required - The wallet address.
  - **protocolName** (String) - Required - The name of the protocol.

### Request Example
```json
{
  "query": "query { protocolBalance ( balances: { chainIds: [1], walletAddress: \"...wallet...\", protocolName: \"Arrakis\" } ){ protocol { slug } total chains { total } } }"
}
```

### Response
#### Success Response (200)
- **data** (Object) - The response data.
  - **protocolBalance** (Object)
    - **protocol** (Object)
      - **slug** (String) - The protocol's unique slug.
    - **total** (Float) - The total balance for the protocol across specified chains.
    - **chains** (Array) - Details about balances per chain.
      - **total** (Float) - The total balance for the specified chain.

#### Response Example
```json
{
  "data": {
    "protocolBalance": {
      "protocol": {
        "slug": "arrakis"
      },
      "total": 250.00,
      "chains": [
        { "total": 250.00 }
      ]
    }
  }
}
```
```

--------------------------------

### Opportunities Dashboard: Opportunity Farms

Source: https://docs.de.fi/api/api

Fetches all platforms and features supported by De.Fi's Explore Yield feature.

```APIDOC
## POST /graphql

### Description
Retrieves a list of all platforms and features supported by De.Fi's Explore Yield feature.

### Method
POST

### Endpoint
/graphql

### Parameters
#### Query Parameters
- **query** (String) - Required - The GraphQL query string.

### Request Example
```json
{
  "query": "query { opportunityFarms { name features { list } } }"
}
```

### Response
#### Success Response (200)
- **data** (Object) - The response data.
  - **opportunityFarms** (Array) - A list of opportunity farm objects.
    - **name** (String) - The name of the platform.
    - **features** (Object)
      - **list** (Array[String]) - A list of yield features offered.

#### Response Example
```json
{
  "data": {
    "opportunityFarms": [
      {
        "name": "Compound",
        "features": {
          "list": ["Lending", "Yield"]
        }
      }
    ]
  }
}
```
```

--------------------------------

### Portfolio Dashboard: Asset Balances

Source: https://docs.de.fi/api/api

Fetches ERC20 balances for EVM chains and general asset balances for non-EVM chains.

```APIDOC
## POST /graphql

### Description
Retrieves asset balances for specified wallet addresses on given chains. Use `assetBalancesAdvanced` for EVM chains and `assetBalances` for non-EVM chains.

### Method
POST

### Endpoint
/graphql

### Parameters
#### Query Parameters
- **query** (String) - Required - The GraphQL query string.

#### Request Body (for `assetBalancesAdvanced`)
- **chainIds** (Array[Int]) - Required - A list of chain IDs to query.
- **walletAddresses** (Array[String]) - Required - A list of wallet addresses to query.

### Request Example (assetBalancesAdvanced)
```json
{
  "query": "query { assetBalancesAdvanced(chainIds: [1, 2], walletAddresses: [\"...wallet #1...\", \"...wallet #2\"]) { total wallet chains { chain { id } } } }"
}
```

### Response
#### Success Response (200)
- **data** (Object) - The response data.
  - **assetBalancesAdvanced** (Object) - Balance information for EVM chains.
    - **total** (Float) - Total balance across all assets.
    - **wallet** (String) - The queried wallet address.
    - **chains** (Array) - Information about balances per chain.
      - **chain** (Object)
        - **id** (Int) - The chain ID.
  - **assetBalances** (Object) - Balance information for non-EVM chains.

#### Response Example (assetBalancesAdvanced)
```json
{
  "data": {
    "assetBalancesAdvanced": {
      "total": 1500.75,
      "wallet": "...wallet #1...",
      "chains": [
        { "chain": { "id": 1 } },
        { "chain": { "id": 2 } }
      ]
    }
  }
}
```
```

--------------------------------

### General Endpoints

Source: https://docs.de.fi/api/api

Provides access to general information such as API credit status, blockchain details, and asset data.

```APIDOC
## POST /graphql

### Description
This endpoint is the main access point for all De.Fi API queries. You can query credits, chains, and assets.

### Method
POST

### Endpoint
`https://public-api.de.fi/graphql`

### Parameters
#### Query Parameters
No query parameters are expected for this endpoint. All requests are made via the request body.

#### Request Body
- **query** (string) - Required - The GraphQL query string.
- **variables** (object) - Optional - Variables to be used in the GraphQL query.

### Request Example
```json
{
  "query": "{ credits { id, owner, available, used } }"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains the data returned by the GraphQL query.
- **errors** (array) - Contains a list of errors if the query fails.

#### Response Example
```json
{
  "data": {
    "credits": [
      {
        "id": "api-key-id",
        "owner": "user@example.com",
        "available": 10000,
        "used": 500
      }
    ]
  }
}
```
```

```APIDOC
## POST /graphql (Chains Endpoint)

### Description
Retrieves information about all supported blockchains integrated into the De.Fi dashboard. The `chain_id` values returned are used in other API calls. Note that the platform uses its own mapping for `chain_id` (e.g., 1 for Ethereum, 2 for BNB, 3 for Polygon).

### Method
POST

### Endpoint
`https://public-api.de.fi/graphql`

### Parameters
#### Request Body
- **query** (string) - Required - The GraphQL query string for chains.

### Request Example
```json
{
  "query": "{ chains { id, name, chain_id, blockchain, currency, explorer } }"
}
```

### Response
#### Success Response (200)
- **data.chains** (array) - A list of chain objects, each containing details about a blockchain.
  - **id** (string) - Unique identifier for the chain entry.
  - **name** (string) - The name of the blockchain.
  - **chain_id** (integer) - The De.Fi internal chain ID.
  - **blockchain** (string) - The official blockchain name.
  - **currency** (string) - The native currency symbol of the blockchain.
  - **explorer** (string) - The URL for the blockchain's block explorer.

#### Response Example
```json
{
  "data": {
    "chains": [
      {
        "id": "chain-1",
        "name": "Ethereum Mainnet",
        "chain_id": 1,
        "blockchain": "ethereum",
        "currency": "ETH",
        "explorer": "https://etherscan.io"
      },
      {
        "id": "chain-2",
        "name": "BNB Smart Chain",
        "chain_id": 2,
        "blockchain": "bsc",
        "currency": "BNB",
        "explorer": "https://bscscan.com"
      }
    ]
  }
}
```
```

```APIDOC
## POST /graphql (Assets Endpoint)

### Description
Retrieves paginated data about all assets integrated into the De.Fi dashboard. This includes information on various tokens across different blockchains.

### Method
POST

### Endpoint
`https://public-api.de.fi/graphql`

### Parameters
#### Request Body
- **query** (string) - Required - The GraphQL query string for assets.
- **variables** (object) - Optional - Variables to specify pagination (e.g., `first`, `after`).

### Request Example
```json
{
  "query": "query GetAssets($first: Int, $after: String) { assets(first: $first, after: $after) { pageInfo { hasNextPage, endCursor }, edges { node { id, name, symbol, decimals, derivedEth, type } } } }",
  "variables": {
    "first": 10,
    "after": null
  }
}
```

### Response
#### Success Response (200)
- **data.assets** (object) - Contains pagination information and a list of asset edges.
  - **pageInfo** (object) - Pagination details.
    - **hasNextPage** (boolean) - Indicates if there are more pages.
    - **endCursor** (string) - The cursor for the last item on the current page.
  - **edges** (array) - A list of asset edges.
    - **node** (object) - Represents an individual asset.
      - **id** (string) - Unique identifier for the asset.
      - **name** (string) - The name of the asset.
      - **symbol** (string) - The symbol of the asset.
      - **decimals** (integer) - The number of decimal places for the asset.
      - **derivedEth** (string) - The value of the asset in ETH.
      - **type** (string) - The type of asset (e.g., 'crypto').

#### Response Example
```json
{
  "data": {
    "assets": {
      "pageInfo": {
        "hasNextPage": true,
        "endCursor": "cursor-string-for-next-page"
      },
      "edges": [
        {
          "node": {
            "id": "bitcoin-id",
            "name": "Bitcoin",
            "symbol": "BTC",
            "decimals": 8,
            "derivedEth": "0.05",
            "type": "crypto"
          }
        },
        {
          "node": {
            "id": "ethereum-id",
            "name": "Ethereum",
            "symbol": "ETH",
            "decimals": 18,
            "derivedEth": "1.0",
            "type": "crypto"
          }
        }
      ]
    }
  }
}
```
```

--------------------------------

### Authentication

Source: https://docs.de.fi/api/api

API key authentication for accessing De.Fi API endpoints.

```APIDOC
## Authentication

### Description
To use the De.Fi API, you must obtain an API key. Send a request to `info@de.fi` to get your key. Include this key in the `X-Api-Key` header for all subsequent requests.

### Method
Any (GET, POST, etc.)

### Endpoint
All De.Fi API endpoints

### Headers
- **X-Api-Key** (String) - Required - Your unique API key.

### Example Usage (GraphQL Playground)
```
# In your GraphQL client or playground, set the header:
X-Api-Key: YOUR_API_KEY_HERE
```
```

--------------------------------

### Scanner Dashboard: Scanner Liquidity Analysis

Source: https://docs.de.fi/api/api

Analyzes liquidity information for tokens.

```APIDOC
## POST /graphql

### Description
Retrieves liquidity analysis details for specified token addresses.

### Method
POST

### Endpoint
/graphql

### Parameters
#### Query Parameters
- **query** (String) - Required - The GraphQL query string.

#### Request Body
- **tokenAddresses** (Array[String]) - Required - A list of token addresses for liquidity analysis.

### Request Example
```json
{
  "query": "query { scannerLiquidityAnalysis(tokenAddresses: [\"0x...token_address_1\"]) { address ...liquidityFields } }"
}
```

### Response
#### Success Response (200)
- **data** (Object) - The response data.
  - **scannerLiquidityAnalysis** (Array) - A list of liquidity analysis objects per token.
    - **address** (String) - The token address.
    - **...liquidityFields** (Various) - Details about liquidity, such as pools and amounts.

#### Response Example
```json
{
  "data": {
    "scannerLiquidityAnalysis": [
      {
        "address": "0x...token_address_1",
        "totalLiquidity": "1000000.00",
        "pools": [
          { "name": "Uniswap V2", "liquidity": "800000.00" }
        ]
      }
    ]
  }
}
```
```

--------------------------------

### Security Dashboard: Shield Advanced

Source: https://docs.de.fi/api/api

Fetches advanced security information for smart contracts.

```APIDOC
## POST /graphql

### Description
Retrieves advanced security analysis for specified smart contract addresses.

### Method
POST

### Endpoint
/graphql

### Parameters
#### Query Parameters
- **query** (String) - Required - The GraphQL query string.

#### Request Body
- **smartContractAddresses** (Array[String]) - Required - A list of smart contract addresses to analyze.

### Request Example
```json
{
  "query": "query { shieldAdvanced(smartContractAddresses: [\"0x...contract_address_1...\", \"0x...contract_address_2\"]) { address ...fields } }"
}
```

### Response
#### Success Response (200)
- **data** (Object) - The response data.
  - **shieldAdvanced** (Array) - A list of security analysis objects for each contract.
    - **address** (String) - The smart contract address.
    - **...fields** (Various) - Various security-related fields (e.g., risk score, vulnerabilities).

#### Response Example
```json
{
  "data": {
    "shieldAdvanced": [
      {
        "address": "0x...contract_address_1",
        "riskScore": 85
      }
    ]
  }
}
```
```

--------------------------------

### Opportunities Dashboard: Opportunities

Source: https://docs.de.fi/api/api

Fetches all available yield opportunities, with filtering options.

```APIDOC
## POST /graphql

### Description
Retrieves available yield opportunities. Allows filtering by platform, feature, chain, and other criteria.

### Method
POST

### Endpoint
/graphql

### Parameters
#### Query Parameters
- **query** (String) - Required - The GraphQL query string.

#### Request Body (example filters)
- **platform** (String) - Optional - Filter by platform name.
- **feature** (String) - Optional - Filter by feature type.
- **chainId** (Int) - Optional - Filter by chain ID.

### Request Example
```json
{
  "query": "query { opportunities(platform: \"Aave\", feature: \"Lending\", chainId: 1) { title description apr } }"
}
```

### Response
#### Success Response (200)
- **data** (Object) - The response data.
  - **opportunities** (Array) - A list of yield opportunity objects.
    - **title** (String) - The title of the opportunity.
    - **description** (String) - A description of the opportunity.
    - **apr** (Float) - The Annual Percentage Rate (APR) for the opportunity.

#### Response Example
```json
{
  "data": {
    "opportunities": [
      {
        "title": "Lend ETH on Compound",
        "description": "Earn interest by lending ETH.",
        "apr": 3.5
      }
    ]
  }
}
```
```

--------------------------------

### Security Dashboard: Shield Approvals

Source: https://docs.de.fi/api/api

Fetches all approvals granted by a specific wallet address.

```APIDOC
## POST /graphql

### Description
Retrieves a list of all token approvals granted by a given wallet address.

### Method
POST

### Endpoint
/graphql

### Parameters
#### Query Parameters
- **query** (String) - Required - The GraphQL query string.

#### Request Body
- **walletAddress** (String) - Required - The wallet address to query approvals for.

### Request Example
```json
{
  "query": "query { shieldApprovals(walletAddress: \"...wallet address...\") { tokenAddress amount } }"
}
```

### Response
#### Success Response (200)
- **data** (Object) - The response data.
  - **shieldApprovals** (Array) - A list of approval objects.
    - **tokenAddress** (String) - The address of the token that was approved.
    - **amount** (String) - The approved amount (can be a large number string).

#### Response Example
```json
{
  "data": {
    "shieldApprovals": [
      {
        "tokenAddress": "0x...token_address...",
        "amount": "1000000000000000000"
      }
    ]
  }
}
```
```

--------------------------------

### Scanner Dashboard: Scanner Project

Source: https://docs.de.fi/api/api

Performs advanced security analysis on smart contracts identified via security dashboard calls.

```APIDOC
## POST /graphql

### Description
Provides advanced security analysis for smart contracts, typically used after obtaining contract addresses from security dashboard queries.

### Method
POST

### Endpoint
/graphql

### Parameters
#### Query Parameters
- **query** (String) - Required - The GraphQL query string.

#### Request Body
- **smartContractAddresses** (Array[String]) - Required - A list of smart contract addresses for analysis.

### Request Example
```json
{
  "query": "query { scannerProject(smartContractAddresses: [\"0x...contract_address_1\"]) { address ...analysisFields } }"
}
```

### Response
#### Success Response (200)
- **data** (Object) - The response data.
  - **scannerProject** (Array) - A list of security analysis results per contract.
    - **address** (String) - The smart contract address.
    - **...analysisFields** (Various) - Detailed security analysis data.

#### Response Example
```json
{
  "data": {
    "scannerProject": [
      {
        "address": "0x...contract_address_1",
        "vulnerabilities": 2,
        "owner": "0x...owner_address..."
      }
    ]
  }
}
```
```

--------------------------------

### Scanner Dashboard: Scanner Holder Analysis

Source: https://docs.de.fi/api/api

Analyzes token holder information for contracts.

```APIDOC
## POST /graphql

### Description
Retrieves detailed holder information for tokens associated with smart contracts.

### Method
POST

### Endpoint
/graphql

### Parameters
#### Query Parameters
- **query** (String) - Required - The GraphQL query string.

#### Request Body
- **tokenAddresses** (Array[String]) - Required - A list of token addresses to analyze holder information for.

### Request Example
```json
{
  "query": "query { scannerHolderAnalysis(tokenAddresses: [\"0x...token_address_1\"]) { address holdersCount topHolders } }"
}
```

### Response
#### Success Response (200)
- **data** (Object) - The response data.
  - **scannerHolderAnalysis** (Array) - A list of holder analysis objects per token.
    - **address** (String) - The token address.
    - **holdersCount** (Int) - The total number of holders.
    - **topHolders** (Array[Object]) - A list of top holder addresses and their proportions.

#### Response Example
```json
{
  "data": {
    "scannerHolderAnalysis": [
      {
        "address": "0x...token_address_1",
        "holdersCount": 15000,
        "topHolders": [
          { "address": "0x...whale_address...", "percentage": "5.1" }
        ]
      }
    ]
  }
}
```
```
Tokens:
Raw