/startCollector

1 min

POST

/startCollector

Start an existing collector on the MPC. You cannot run a collector until after adding it to the MPC via addCollector.

return: JSON with results and status code.

Input Example:

.. code-block::

startCollector(
    collector_config_3
)

Response Example:

.. code-block::

{
    "FunctionData": {
        "IgnoredCurrencies": {
            "ETH": 5
        },
        "RunId": "7f67df06-a4a4-42d7-8827-331655332565",
        "StatusCode": 0
    },
    "Meta": {
      "AccessToken": "58f08df6e369fa4d126e1ba5c7f66cf85c9c79df32d05fee8f3c542121c87cf5",
      "Destination": "044fd7dc60304b8aceeb662ce41bf9d9cc132278c0871c0a72fb4f3cecbabb25a86e43ae28dab21a95c64e2db76abdcfffb9bfdeec67a21399cfa5f555f01d054b",
      "Source": "be1f60e490b8ccabcc02a4595817b8edf45905d24944e87b8e3cae27f158df63843bfc4b09d37a5e752017b74ea2d136af272bea210f059e768e1ea8777aaf21e9",
      "Time": "2025-10-19 15:04:13.129"
    }
}

Possible status codes:

OK = 0,

ACCOUNT_EXISTS = 1,

IS_ALREADY_RUNNING = 2,

NOT_EXISTS = 3,

PERMISSION_DENIED = 4,

BAD_REQUEST = 400,

TECHNICAL_ERROR = 500

configobjectthe config that has been built for the collector

acceptstringGenerated from available response content types

bodyobject

200success

curl --request POST \
     --url '/startCollector?config=%22{%5Cn%20%20%5C%22account_id_to_collector_address%5C%22%3A%20{%5Cn%20%20%20%20%5C%221%5C%22%3A%20%5C%220xF1722F2c8Bab975C321321E2942E0dCb951B9C4F%5C%22%5Cn%20%20}%2C%5Cn%20%20%5C%22network_symbol_to_network_limits%5C%22%3A%20{%5Cn%20%20%20%20%5C%22ETH%5C%22%3A%20{%5Cn%20%20%20%20%20%20%5C%22symbol%5C%22%3A%20%5C%22ETH%5C%22%2C%5Cn%20%20%20%20%20%20%5C%22limits%5C%22%3A%20[%5Cn%20%20%20%20%20%20%20%20{%5Cn%20%20%20%20%20%20%20%20%20%20%5C%22max_total_fee%5C%22%3A%2010000000000000000000%2C%5Cn%20%20%20%20%20%20%20%20%20%20%5C%22max_priority_fee%5C%22%3A%201000000000000%5Cn%20%20%20%20%20%20%20%20}%5Cn%20%20%20%20%20%20]%5Cn%20%20%20%20}%5Cn%20%20}%2C%5Cn%20%20%5C%22currency_symbol_to_currency_limits%5C%22%3A%20{%5Cn%20%20%20%20%5C%22ETH%5C%22%3A%20{%5Cn%20%20%20%20%20%20%5C%22symbol%5C%22%3A%20%5C%22ETH%5C%22%2C%5Cn%20%20%20%20%20%20%5C%22limits%5C%22%3A%20[%5Cn%20%20%20%20%20%20%20%20{%5Cn%20%20%20%20%20%20%20%20%20%20%5C%22fee_ratio%5C%22%3A%201%2C%5Cn%20%20%20%20%20%20%20%20%20%20%5C%22fee_cap%5C%22%3A%20132000000854001%5Cn%20%20%20%20%20%20%20%20}%5Cn%20%20%20%20%20%20]%5Cn%20%20%20%20}%5Cn%20%20}%5Cn}%5Cn%22' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data-raw '{
     "FunctionData": {
     "Config": {
     "Accounts": {
     "1": {
     "CollectorAddress": "0xF1722F2c8Bab975C321321E2942E0dCb951B9C4F"
     }
     },
     "CollectorId": "1",
     "CreationTime": 10,
     "CreatorUserId": "[email protected]",
     "Limits": {
     "Currencies": {
     "ETH": {
     "FeeCap": "132000000854001",
     "FeeRatio": "1"
     }
     },
     "Networks": {
     "ETH": {
     "MaxTotalFee": "10000000000000000000"
     }
     }
     },
     "Name": "myCollector"
     },
     "InitiatorUserId": "[email protected]"
     },
     "Meta": {
     "FunctionName": "startCollector",
     "RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
     "Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
     "Time": "2021-02-07T18:37:46.948Z",
     "Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
     "AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
     }
     }'