---
title: /getCollectors
slug: getcollectors
createdAt: 2024-01-09T12:30:00.567Z
---

{
  "id": "Hto13DX9dO7H3PFc3Ja1z",
  "type": "api-oas-v2",
  "data": {
    "method": "POST",
    "url": "http://1.1.1.1/getCollectors",
    "servers": [
      {
        "url": "http://1.1.1.1/getCollectors"
      }
    ],
    "name": "",
    "description": "<p>Calling this request can be used for retrieve existing collectors configurations</p>\n<ul>\n<li>\n<p>return - json with results and status code</p>\n</li>\n<li>\n<p>Possible status codes:</p>\n</li>\n</ul>\n<p>OK = 0,</p>\n<p>ACCOUNT_EXISTS = 1,</p>\n<p>IS_ALREADY_RUNNING = 2,</p>\n<p>NOT_EXISTS = 3,</p>\n<p>PERMISSION_DENIED = 4,</p>\n<p>BAD_REQUEST = 400,</p>\n<p>TECHNICAL_ERROR = 500</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [],
      "queryParameters": [],
      "bodyDataParameters": [
        {
          "kind": "optional",
          "name": "body",
          "type": "object",
          "customType": "getCollectorsRequest",
          "schema": [
            {
              "name": "FunctionData",
              "kind": "optional",
              "type": "object",
              "example": "",
              "schema": []
            },
            {
              "name": "Meta",
              "kind": "optional",
              "type": "object",
              "modelRef": "#/components/schemas/MetaTokengetCollectors",
              "customType": "MetaTokengetCollectors",
              "schema": [
                {
                  "name": "FunctionName",
                  "kind": "optional",
                  "type": "string",
                  "description": "The Function to be called",
                  "example": "getCollectors",
                  "default": "getCollectors"
                },
                {
                  "name": "RandomData",
                  "kind": "optional",
                  "type": "string",
                  "description": "Random Data",
                  "example": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
                  "default": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229"
                },
                {
                  "name": "Destination",
                  "kind": "optional",
                  "type": "string",
                  "description": "Id of the server",
                  "example": "",
                  "default": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea"
                },
                {
                  "name": "Time",
                  "kind": "optional",
                  "type": "string",
                  "description": "UTC Time of execution",
                  "example": "2021-02-07T18:37:46.948Z",
                  "default": "2021-02-07T18:37:46.948Z"
                },
                {
                  "name": "Source",
                  "kind": "optional",
                  "type": "string",
                  "description": "User public key",
                  "example": "",
                  "default": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99"
                },
                {
                  "name": "AccessToken",
                  "kind": "optional",
                  "type": "string",
                  "description": "Token used for authentication purposes",
                  "example": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087",
                  "default": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
                }
              ]
            }
          ],
          "modelRef": "#/components/schemas/getCollectorsRequest",
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "success",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "customType": "getCollectorsResponse",
            "schema": [
              {
                "name": "FunctionData",
                "kind": "optional",
                "type": "object",
                "example": "{\"Collectors\":[{\"Config\":{\"Accounts\":{\"1\":{\"CollectorAddress\":\"0x862842A56B5D5F30B7d519cCe683983F57499cE6\"}},\"CollectorId\":\"da305093-f9d7-4794-93f3-c755b1d5a967\",\"CreationTime\":1683627379,\"CreatorUserId\":\"bob@gk8.io\",\"Limits\":{\"Currencies\":{\"ETH\":{\"FeeCap\":\"5000000000000000000\",\"FeeRatio\":\"1\"}},\"Networks\":{\"ETH\":{\"MaxPriorityFee\":\"3000000000\",\"MaxTotalFee\":\"3400000000000000000\"}}},\"Name\":\"asd\",\"Type\":0},\"RunId\":\"45342d2d-d603-4426-ad25-065bad7eba34\"}]}",
                "schema": [
                  {
                    "name": "Collectors",
                    "kind": "optional",
                    "type": "array",
                    "example": "",
                    "itemType": "object",
                    "customType": "object[]",
                    "schema": [
                      {
                        "name": "Config",
                        "kind": "optional",
                        "type": "object",
                        "example": "",
                        "schema": [
                          {
                            "name": "Accounts",
                            "kind": "optional",
                            "type": "object",
                            "example": "",
                            "schema": [
                              {
                                "name": "1",
                                "kind": "optional",
                                "type": "object",
                                "example": "",
                                "schema": [
                                  {
                                    "name": "CollectorAddress",
                                    "kind": "optional",
                                    "type": "string",
                                    "example": "0x862842A56B5D5F30B7d519cCe683983F57499cE6",
                                    "default": "0x862842A56B5D5F30B7d519cCe683983F57499cE6"
                                  }
                                ]
                              }
                            ]
                          },
                          {
                            "name": "CollectorId",
                            "kind": "optional",
                            "type": "string",
                            "example": "da305093-f9d7-4794-93f3-c755b1d5a967",
                            "default": "da305093-f9d7-4794-93f3-c755b1d5a967"
                          },
                          {
                            "name": "CreationTime",
                            "kind": "optional",
                            "type": "integer",
                            "example": 1683627379,
                            "default": 1683627379
                          },
                          {
                            "name": "CreatorUserId",
                            "kind": "optional",
                            "type": "string",
                            "example": "bob@gk8.io",
                            "default": "bob@gk8.io"
                          },
                          {
                            "name": "Limits",
                            "kind": "optional",
                            "type": "object",
                            "example": "",
                            "schema": [
                              {
                                "name": "Currencies",
                                "kind": "optional",
                                "type": "object",
                                "example": "",
                                "schema": [
                                  {
                                    "name": "ETH",
                                    "kind": "optional",
                                    "type": "object",
                                    "example": "",
                                    "schema": [
                                      {
                                        "name": "FeeCap",
                                        "kind": "optional",
                                        "type": "string",
                                        "example": "5000000000000000000",
                                        "default": "5000000000000000000"
                                      },
                                      {
                                        "name": "FeeRatio",
                                        "kind": "optional",
                                        "type": "string",
                                        "example": "1",
                                        "default": "1"
                                      }
                                    ]
                                  }
                                ]
                              },
                              {
                                "name": "Networks",
                                "kind": "optional",
                                "type": "object",
                                "example": "",
                                "schema": [
                                  {
                                    "name": "ETH",
                                    "kind": "optional",
                                    "type": "object",
                                    "example": "",
                                    "schema": [
                                      {
                                        "name": "MaxPriorityFee",
                                        "kind": "optional",
                                        "type": "string",
                                        "example": "3000000000",
                                        "default": "3000000000"
                                      },
                                      {
                                        "name": "MaxTotalFee",
                                        "kind": "optional",
                                        "type": "string",
                                        "example": "3400000000000000000",
                                        "default": "3400000000000000000"
                                      }
                                    ]
                                  }
                                ]
                              }
                            ]
                          },
                          {
                            "name": "Name",
                            "kind": "optional",
                            "type": "string",
                            "example": "asd",
                            "default": "asd"
                          },
                          {
                            "name": "Type",
                            "kind": "optional",
                            "type": "integer",
                            "example": 0,
                            "default": 0
                          }
                        ]
                      },
                      {
                        "name": "RunId",
                        "kind": "optional",
                        "type": "string",
                        "example": ""
                      }
                    ]
                  }
                ]
              },
              {
                "name": "Meta",
                "kind": "optional",
                "type": "object",
                "modelRef": "#/components/schemas/MetaResponse",
                "customType": "MetaResponse",
                "schema": [
                  {
                    "name": "AccessToken",
                    "kind": "optional",
                    "type": "string",
                    "description": "The new access token generated after this operation",
                    "example": "a3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6",
                    "default": "a3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6"
                  },
                  {
                    "name": "Destination",
                    "kind": "optional",
                    "type": "string",
                    "description": "Id of the server",
                    "example": "042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622",
                    "default": "042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622"
                  },
                  {
                    "name": "Source",
                    "kind": "optional",
                    "type": "string",
                    "description": "User public key",
                    "example": "df4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355",
                    "default": "df4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355"
                  },
                  {
                    "name": "Time",
                    "kind": "optional",
                    "type": "string",
                    "description": "UTC Time of execution",
                    "example": "2021-02-14 09:58:52.320",
                    "default": "2021-02-14 09:58:52.320"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/getCollectorsResponse",
            "isExpanded": true
          }
        ]
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request POST \\\n     --url http://1.1.1.1/getCollectors \\\n     --header 'accept: application/json' \\\n     --header 'content-type: application/json' \\\n     --data '{\n     \"Meta\": {\n     \"FunctionName\": \"getCollectors\",\n     \"RandomData\": \"288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229\",\n     \"Destination\": \"b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea\",\n     \"Time\": \"2021-02-07T18:37:46.948Z\",\n     \"Source\": \"048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99\",\n     \"AccessToken\": \"51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087\"\n     }\n     }'"
        },
        {
          "id": "example-1-javascript",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n   \"Meta\": {\n      \"FunctionName\": \"getCollectors\",\n      \"RandomData\": \"288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229\",\n      \"Destination\": \"b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea\",\n      \"Time\": \"2021-02-07T18:37:46.948Z\",\n      \"Source\": \"048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99\",\n      \"AccessToken\": \"51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087\"\n   }\n});\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   body: raw,\n   redirect: 'follow'\n};\n\nfetch(\"http://1.1.1.1/getCollectors\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "example-2-ruby",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"http://1.1.1.1/getCollectors\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n   \"Meta\": {\n      \"FunctionName\": \"getCollectors\",\n      \"RandomData\": \"288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229\",\n      \"Destination\": \"b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea\",\n      \"Time\": \"2021-02-07T18:37:46.948Z\",\n      \"Source\": \"048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99\",\n      \"AccessToken\": \"51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087\"\n   }\n})\n\nresponse = http.request(request)\nputs response.read_body\n"
        },
        {
          "id": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"http://1.1.1.1/getCollectors\"\n\npayload = json.dumps({\n   \"Meta\": {\n      \"FunctionName\": \"getCollectors\",\n      \"RandomData\": \"288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229\",\n      \"Destination\": \"b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea\",\n      \"Time\": \"2021-02-07T18:37:46.948Z\",\n      \"Source\": \"048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99\",\n      \"AccessToken\": \"51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087\"\n   }\n})\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// success\n{\n  \"FunctionData\": {\n    \"Collectors\": [\n      {\n        \"Config\": {\n          \"Accounts\": {\n            \"1\": {\n              \"CollectorAddress\": \"0x862842A56B5D5F30B7d519cCe683983F57499cE6\"\n            }\n          },\n          \"CollectorId\": \"da305093-f9d7-4794-93f3-c755b1d5a967\",\n          \"CreationTime\": 1683627379,\n          \"CreatorUserId\": \"bob@gk8.io\",\n          \"Limits\": {\n            \"Currencies\": {\n              \"ETH\": {\n                \"FeeCap\": \"5000000000000000000\",\n                \"FeeRatio\": \"1\"\n              }\n            },\n            \"Networks\": {\n              \"ETH\": {\n                \"MaxPriorityFee\": \"3000000000\",\n                \"MaxTotalFee\": \"3400000000000000000\"\n              }\n            }\n          },\n          \"Name\": \"asd\",\n          \"Type\": 0\n        },\n        \"RunId\": \"\"\n      }\n    ]\n  },\n  \"Meta\": {\n    \"AccessToken\": \"a3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6\",\n    \"Destination\": \"042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622\",\n    \"Source\": \"df4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355\",\n    \"Time\": \"2021-02-14 09:58:52.320\"\n  }\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "id": "oZ3UHu0GdXQIQNQS7QGEr",
      "type": "paragraph",
      "children": [
        {
          "text": "Calling this request can be used for retrieve existing collectors configurations",
          "id": "9CammxvRmcsLGQiTvWfwm"
        }
      ]
    },
    {
      "id": "a6KAKF9Vmb8YU9cA7bJuJ",
      "type": "bulleted-list",
      "children": [
        {
          "id": "NkX_Dfj-hL5tF5uOw7Lfc",
          "type": "list-item",
          "children": [
            {
              "id": "Bjxmg08GSaVHGTXhRpJr6",
              "type": "list-item-child",
              "children": [
                {
                  "text": "return - json with results and status code",
                  "id": "fEnwc4sfItPsmIPeTDzB_"
                }
              ]
            }
          ]
        },
        {
          "id": "ulaLwEMW1USIAUDcr1pKA",
          "type": "list-item",
          "children": [
            {
              "id": "qzWpqYspWJWG4QaV9NxRf",
              "type": "list-item-child",
              "children": [
                {
                  "text": "Possible status codes:",
                  "id": "sraqCm8ygrwpyyd1qgsQb"
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "id": "dGStPO59MkLQKTpIDSj4C",
      "type": "paragraph",
      "children": [
        {
          "text": "OK = 0,",
          "id": "1Uq_IQBrm8Y0kTCyUx5Kw"
        }
      ]
    },
    {
      "id": "7FQdriFW_Url9sp-6boI7",
      "type": "paragraph",
      "children": [
        {
          "text": "ACCOUNT_EXISTS = 1,",
          "id": "-4SLlch_vQf2W7_sbfsIm"
        }
      ]
    },
    {
      "id": "aLJNH--3RFvlsPBpOfPWk",
      "type": "paragraph",
      "children": [
        {
          "text": "IS_ALREADY_RUNNING = 2,",
          "id": "B6SUc5e2gUveMWJbIr2sW"
        }
      ]
    },
    {
      "id": "a5HIi3nxZzDEgY6lkVBU4",
      "type": "paragraph",
      "children": [
        {
          "text": "NOT_EXISTS = 3,",
          "id": "TJ89VBg5Qu1WZPiocU9U4"
        }
      ]
    },
    {
      "id": "xy8FFBEE7CeecWRTwSDBp",
      "type": "paragraph",
      "children": [
        {
          "text": "PERMISSION_DENIED = 4,",
          "id": "wp_WQULQplHg3_zTzgILZ"
        }
      ]
    },
    {
      "id": "THTLTZIvIH9Lepp0udd1w",
      "type": "paragraph",
      "children": [
        {
          "text": "BAD_REQUEST = 400,",
          "id": "RUGIbSetSQA1RDOMmq9FN"
        }
      ]
    },
    {
      "id": "ZdcpbeG4UN9icVxXguxaX",
      "type": "paragraph",
      "children": [
        {
          "text": "TECHNICAL_ERROR = 500",
          "id": "jdLgSY6LeqFDl7gYoCvGV"
        }
      ]
    }
  ]
}