> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wallchain.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# API Overview

> The overview of the API based on the chains and wallets

# How to Integrate

The structure of the entities considered by our API is as follows.

```mermaid theme={null}
graph
    W(Wallet/User) --> ETH(Ethereum Mainnet)
    W --> BSC(BSC)
    W --> Arb(Arbitrum)
    ETH --> WETH_eth(WETH)
    ETH --> USDC_eth(USDC)
    ETH --> USDT_eth(USDT)
    BSC --> USDC_bsc(USDC)
    BSC --> USDT_bsc(USDT)
    Arb --> USDC_arb(USDC)
    Arb --> USDT_arb(USDT)
```

## Controlling deposits

### Un-deposit for certain wallet/chain/token

To forcefully withdraw funds and pause the auto-depositing mechanism for a certain time

* `POST /v1/:walletId/:networkId/:tokenAddress/withdraw?pause=<duration>`
* `POST /v1/:walletId/:networkId/withdraw?pause=<duration>`
* `POST /v1/:walletId/withdraw?pause=<duration>`

### Get information on the amount of money accrued for certain chain/token

* `GET /v1/:walletId/:networkId/yieldAccrued`
* `GET /v1/:walletId/:tokenAddress/yieldAccrued`
* `GET /v1/:walletId/yieldAccrued`

### `GET /v1/providers/:networkId`

Get a list of supported yield providers