/getCollectorHistory

1 min

POST

Retrieve and display information about all collectors' runs.

return: JSON with results and status code.

Input Example:

.. code-block::

getCollectorHistory(
    offset=0,
    limit=10
)

Response Example:

.. code-block::

{
    "FunctionData": {
        "History": [
            {
                "AffectedAddressesCount": 0,
                "CollectedValueInFiat": {
                    "Amount": "0"
                },
                "CollectedValueInFiatByCurrency": {},
                "CollectionStatus": 0,
                "CollectorId": "58d77c03-eba7-45a4-9ade-cdf4c0ecfba2",
                "EndTime": 1729505880,
                "IgnoredAddressesPerCurrency": {},
                "IgnoredCurrencies": {
                    "ETH": 5
                },
                "InitiatorUserId": "[email protected]",
                "RunId": "158dea90-0365-45da-a251-8e0333e10e62",
                "StartTime": 1729505870,
                "TotalFeesInFiat": {
                    "Amount": "0"
                }
            },
            {
                "AffectedAddressesCount": 0,
                "CollectedValueInFiat": {
                    "Amount": "0"
                },
                "CollectedValueInFiatByCurrency": {},
                "CollectionStatus": 0,
                "CollectorId": "dd0d6b88-484b-404d-8fe5-b7cef2721e94",
                "EndTime": 1729512612,
                "IgnoredAddressesPerCurrency": {},
                "IgnoredCurrencies": {
                    "ETH": 5
                },
                "InitiatorUserId": "[email protected]",
                "RunId": "7f67df06-a4a4-42d7-8827-331655332565",
                "StartTime": 1729512592,
                "TotalFeesInFiat": {
                    "Amount": "0"
                }
            }
        ],
        "StatusCode": 0,
        "Total": 2
    },
    "Meta": {
        "AccessToken": "e59612cdcb1242af750f4f8cc9032a4d44bfdb40b00bd19c5e5ef5d538fc74a0",
        "Destination": "0473aa0362d3998baab6880822e838133a061c379b8e146bcded46deb4805aa83139a3c578293161bca7926e53ef20888977f4030c38d42aae10b36c3309c0f766",
        "Source": "762b6aa122a0ba22557a0cf5ea0c49953e64f7485ffb7857f26541f748e36e83b2e4cca777569511214fcf68f3301a322bbdf15e7479ae0d695fcf40c30a81ff56",
        "Time": "2025-09-30 15:25:43.678"
    }
}

Possible status codes:

OK = 0,

ACCOUNT_EXISTS = 1,

IS_ALREADY_RUNNING = 2,

NOT_EXISTS = 3,

PERMISSION_DENIED = 4,

BAD_REQUEST = 400,

TECHNICAL_ERROR = 500

offsetintegeroffset from start

limitintegermaximum results

acceptstringGenerated from available response content types

bodyobjectRequest data for Collector operations.

200success

curl --request POST \
     --url '/getCollectorHistory?offset=integer&limit=100' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "Limit": 100,
     "Meta": {
     "FunctionName": "getCollectorHistory",
     "RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
     "Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
     "Time": "2021-02-07T18:37:46.948Z",
     "Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
     "AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
     }
     }'