---
agentTools:
  projectIndex: https://finrock.readme.io/llms.txt
---

# Auto Forwarding

Auto forward balances to an external address

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Prod",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.finrock.io"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/dac/v1/auto-forwarding": {
      "post": {
        "summary": "Auto Forwarding",
        "description": "Auto forward balances to an external address",
        "operationId": "auto-forwarding",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "asset",
                  "address"
                ],
                "properties": {
                  "asset": {
                    "type": "string",
                    "description": "asset ticker (e.g. BTC)"
                  },
                  "address": {
                    "type": "string",
                    "description": "external address where funds must be sent to"
                  },
                  "frequency": {
                    "type": "string",
                    "description": "how soon funds should be forwarded to the external address.",
                    "default": "Nightly",
                    "enum": [
                      "Nightly",
                      "RealTime"
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"code\": 1000,\n    \"error\": null,\n    \"info\": null\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "integer",
                      "example": 1000,
                      "default": 0
                    },
                    "error": {},
                    "info": {}
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false,
        "x-readme": {
          "code-samples": [
            {
              "language": "text",
              "code": "{\n    \"asset\": \"ETH_TEST\",\n    \"address\": \"0xd9986d6574ba977e2C22d728564E5Af55fdF3f18\",\n    \"frequency\": \"Nigtly\"\n}"
            }
          ],
          "samples-languages": [
            "text"
          ]
        }
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "61ec7ec6c85949003bb883dc:684333c757f25100710ee200"
}
```