---
title: /searchTransactions
slug: searchtransactions
createdAt: 2024-01-09T12:30:00.561Z
---

{
  "id": "0g9eoGuxLlNf34UsJOL2H",
  "type": "api-oas-v2",
  "data": {
    "method": "POST",
    "url": "http://1.1.1.1/searchTransactions",
    "servers": [
      {
        "url": "http://1.1.1.1/searchTransactions"
      }
    ],
    "name": "",
    "description": "<ul>\n<li>\n<p>This function is used to search for transactions based on various filters.</p>\n</li>\n<li>\n<p>return - amount of extracted transactions in system for given filters</p>\n</li>\n</ul>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [],
      "queryParameters": [
        {
          "kind": "optional",
          "name": "include_output_transactions",
          "type": "boolean",
          "example": "False",
          "description": "<p>indicating if we want output transactions, true if you want to include Output Transactions</p>",
          "default": "False"
        },
        {
          "kind": "optional",
          "name": "include_input_transactions",
          "type": "boolean",
          "example": "False",
          "description": "<p>indicating if we want input transactions, true if you want to include Input Transactions</p>",
          "default": "False"
        },
        {
          "kind": "optional",
          "name": "currencies",
          "type": "array",
          "example": "[\"ETH\"]",
          "description": "list of requested currencies, currencies used in this operation (BTC,ETH,BCH,XRP,etc)",
          "default": [
            "ETH"
          ],
          "schema": [],
          "itemType": "string",
          "customType": "string[]"
        },
        {
          "kind": "optional",
          "name": "accounts",
          "type": "array",
          "example": "[1,2]",
          "description": "Accounts used in this operation",
          "default": [
            1,
            2
          ],
          "schema": [],
          "itemType": "integer",
          "customType": "integer[]"
        },
        {
          "kind": "optional",
          "name": "creators",
          "type": "array",
          "example": "[\"bob@gk8.io\",\"John@gk8.io\"]",
          "description": "list of Id's of the creators of the transaction",
          "default": [
            "bob@gk8.io",
            "John@gk8.io"
          ],
          "schema": [],
          "itemType": "string",
          "customType": "string[]"
        },
        {
          "kind": "optional",
          "name": "user_description",
          "type": "string",
          "example": "Transaction No' 1",
          "description": "<p>sub string insensitive to search in user description, Description of the transaction you want to fetch</p>",
          "default": "Transaction No' 1"
        },
        {
          "kind": "optional",
          "name": "start_date_time_in_milliseconds_since_epoch",
          "type": "integer",
          "description": "filter transactions from that time"
        },
        {
          "kind": "optional",
          "name": "end_date_time_in_milliseconds_since_epoch",
          "type": "integer",
          "description": "<p>The end date of the transactions (in unix Epoch time)</p>"
        },
        {
          "kind": "optional",
          "name": "status_keys",
          "type": "array",
          "example": "APPROVED",
          "description": "specified status keys for the transaction",
          "default": "APPROVED",
          "schema": [],
          "itemType": "string",
          "customType": "string[]"
        },
        {
          "kind": "optional",
          "name": "limit_rows",
          "type": "integer",
          "example": 10,
          "description": "int Max number of transactions to return",
          "default": 10
        },
        {
          "kind": "optional",
          "name": "wallet_ids",
          "type": "array",
          "description": "the wallets's ids receieved in the operation",
          "schema": [],
          "itemType": "string",
          "customType": "string[]"
        },
        {
          "kind": "optional",
          "name": "include_high_risk_transactions",
          "type": "boolean",
          "example": "False",
          "description": "<p>bool indicating to include transactions deemed high risk by AML service</p>\n<ul>\n<li>True - includes all transactions, both low risk and high risk</li>\n<li>False - only include low risk transactions, high risk transactions are excluded</li>\n<li>representing the required transaction statuses.</li>\n<li>e.g: [1,2,5] - all the transactions whose their status is FAILED_LIMITATIONS or FAILED_TECHNICAL or FAILED_NO_FUNDS</li>\n<li>[10,11] - all the transactions whose their status is CANCELED_GROUP_CHANGED or CANCELED_ACCOUNT_APRROVERS_CHANGED</li>\n</ul>",
          "default": "False"
        }
      ],
      "bodyDataParameters": [
        {
          "kind": "optional",
          "name": "body",
          "type": "object",
          "description": "Request data for filtering transactions.",
          "customType": "searchTransactionsRequest",
          "schema": [
            {
              "name": "Creators",
              "kind": "optional",
              "type": "array",
              "description": "An array of creator emails.",
              "example": "[\"bob@gk8.io\",\"John@gk8.io\"]",
              "default": [
                "bob@gk8.io",
                "John@gk8.io"
              ],
              "itemType": "string",
              "customType": "string[]",
              "itemExample": "",
              "itemDefault": ""
            },
            {
              "name": "Currencies",
              "kind": "optional",
              "type": "array",
              "description": "An array of currency symbols.",
              "example": "[\"ETH\"]",
              "default": [
                "ETH"
              ],
              "itemType": "string",
              "customType": "string[]",
              "itemExample": "",
              "itemDefault": ""
            },
            {
              "name": "IncludeHighRiskTransactions",
              "kind": "optional",
              "type": "boolean",
              "description": "Flag to include high-risk transactions.",
              "example": "false",
              "default": "false"
            },
            {
              "name": "StatusKeys",
              "kind": "optional",
              "type": "array",
              "description": "An array of status keys.",
              "example": "[0]",
              "default": [
                0
              ],
              "itemType": "integer",
              "customType": "integer[]",
              "itemExample": "",
              "itemDefault": ""
            },
            {
              "name": "UserDescription",
              "kind": "optional",
              "type": "string",
              "description": "User-defined transaction description.",
              "example": "Transaction No' 1",
              "default": "Transaction No' 1"
            },
            {
              "name": "WalletIds",
              "kind": "optional",
              "type": "array",
              "description": "An array of wallet IDs.",
              "example": "[\"wal1\",\"wal2\"]",
              "default": [
                "wal1",
                "wal2"
              ],
              "itemType": "string",
              "customType": "string[]",
              "itemExample": "",
              "itemDefault": ""
            },
            {
              "name": "Meta",
              "kind": "optional",
              "type": "object",
              "modelRef": "#/components/schemas/MetaTokensearchTransactions",
              "customType": "MetaTokensearchTransactions",
              "schema": [
                {
                  "name": "FunctionName",
                  "kind": "optional",
                  "type": "string",
                  "description": "The Function to be called",
                  "example": "searchTransactions",
                  "default": "searchTransactions"
                },
                {
                  "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/searchTransactionsRequest",
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "success",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "schema": [
              {
                "name": "FunctionData",
                "kind": "optional",
                "type": "object",
                "example": "",
                "schema": [
                  {
                    "name": "ExtractedTransactionsCount",
                    "kind": "optional",
                    "type": "integer",
                    "description": "Number of transactions that were valid for this search",
                    "example": 34,
                    "default": 34
                  }
                ]
              },
              {
                "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"
                  }
                ]
              }
            ],
            "isExpanded": true
          }
        ]
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request POST \\\n     --url 'http://1.1.1.1/searchTransactions?include_output_transactions=False&include_input_transactions=False&currencies=ETH&accounts=1%2C2&creators=bob%40gk8.io%2CJohn%40gk8.io&user_description=Transaction%20No%27%201&status_keys=APPROVED&limit_rows=10&include_high_risk_transactions=False' \\\n     --header 'accept: application/json' \\\n     --header 'content-type: application/json' \\\n     --data-raw '{\n     \"Creators\": [\n     \"bob@gk8.io\",\n     \"John@gk8.io\"\n     ],\n     \"Currencies\": [\n     \"ETH\"\n     ],\n     \"IncludeHighRiskTransactions\": \"false\",\n     \"StatusKeys\": [\n     0\n     ],\n     \"UserDescription\": \"Transaction No'\\'' 1\",\n     \"WalletIds\": [\n     \"wal1\",\n     \"wal2\"\n     ],\n     \"Meta\": {\n     \"FunctionName\": \"searchTransactions\",\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   \"Creators\": [\n      \"bob@gk8.io\",\n      \"John@gk8.io\"\n   ],\n   \"Currencies\": [\n      \"ETH\"\n   ],\n   \"IncludeHighRiskTransactions\": \"false\",\n   \"StatusKeys\": [\n      0\n   ],\n   \"UserDescription\": \"Transaction No' 1\",\n   \"WalletIds\": [\n      \"wal1\",\n      \"wal2\"\n   ],\n   \"Meta\": {\n      \"FunctionName\": \"searchTransactions\",\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/searchTransactions?include_output_transactions=False&include_input_transactions=False&currencies=ETH&accounts=1,2&creators=bob@gk8.io,John@gk8.io&user_description=Transaction No' 1&status_keys=APPROVED&limit_rows=10&include_high_risk_transactions=False\", 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/searchTransactions?include_output_transactions=False&include_input_transactions=False&currencies=ETH&accounts=1,2&creators=bob@gk8.io,John@gk8.io&user_description=Transaction No' 1&status_keys=APPROVED&limit_rows=10&include_high_risk_transactions=False\")\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   \"Creators\": [\n      \"bob@gk8.io\",\n      \"John@gk8.io\"\n   ],\n   \"Currencies\": [\n      \"ETH\"\n   ],\n   \"IncludeHighRiskTransactions\": \"false\",\n   \"StatusKeys\": [\n      0\n   ],\n   \"UserDescription\": \"Transaction No' 1\",\n   \"WalletIds\": [\n      \"wal1\",\n      \"wal2\"\n   ],\n   \"Meta\": {\n      \"FunctionName\": \"searchTransactions\",\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/searchTransactions?include_output_transactions=False&include_input_transactions=False&currencies=ETH&accounts=1,2&creators=bob@gk8.io,John@gk8.io&user_description=Transaction No' 1&status_keys=APPROVED&limit_rows=10&include_high_risk_transactions=False\"\n\npayload = json.dumps({\n   \"Creators\": [\n      \"bob@gk8.io\",\n      \"John@gk8.io\"\n   ],\n   \"Currencies\": [\n      \"ETH\"\n   ],\n   \"IncludeHighRiskTransactions\": \"false\",\n   \"StatusKeys\": [\n      0\n   ],\n   \"UserDescription\": \"Transaction No' 1\",\n   \"WalletIds\": [\n      \"wal1\",\n      \"wal2\"\n   ],\n   \"Meta\": {\n      \"FunctionName\": \"searchTransactions\",\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    \"ExtractedTransactionsCount\": 34\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": "Ln6DXfhxSKXNLJTlKDv03",
      "type": "bulleted-list",
      "children": [
        {
          "id": "7Jmm2nRGSw1LU8YATEcJ6",
          "type": "list-item",
          "children": [
            {
              "id": "DlTkvcf240LtSZsyxVDCp",
              "type": "list-item-child",
              "children": [
                {
                  "text": "This function is used to search for transactions based on various filters.",
                  "id": "AuOy2CKYDHOfh6loqifqf"
                }
              ]
            }
          ]
        },
        {
          "id": "2EIdAnj_IopF0XnVK9C86",
          "type": "list-item",
          "children": [
            {
              "id": "lJBOMOzWMgI7kVsogPerX",
              "type": "list-item-child",
              "children": [
                {
                  "text": "return - amount of extracted transactions in system for given filters",
                  "id": "5MbfQ7kmJhDxjC1qEzyvG"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}