{"Package":"okxAPI","Title":"An Unofficial Wrapper for 'okx exchange v5' API","Version":"0.1.1","Authors@R":"person(family = \"Fang\", given = \"Yongchao\", email = \"yongchao.fang@outlook.com\", role = c(\"aut\", \"cre\", \"cph\"))","Description":"An unofficial wrapper for 'okx exchange v5' API , including 'REST' API and 'WebSocket' API.","License":"MIT + file LICENSE","Encoding":"UTF-8","RoxygenNote":"7.2.3","Imports":"R6, data.table, httr, base64enc, jsonlite, websocket, digest","NeedsCompilation":"no","Packaged":"2023-04-21 12:04:16 UTC; fangyongchao","Author":"Yongchao Fang [aut, cre, cph]","Maintainer":"Yongchao Fang ","Repository":"CRAN","Date/Publication":"2023-04-22 07:10:02 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/okxAPI_0.1.1.tar.gz","jsonAuthors":[{"name":"Yongchao Fang","email":"yongchao.fang@outlook.com","maintainer":true}],"readme":"# okxAPI\n\nAn unofficial wrapper for [Okx exchange v5 API](https://www.okx.com/docs-v5/en/)\n\n## Installation\n\nYou can install the released version of okxAPI from [CRAN](https://CRAN.R-project.org) with:\n\n``` r\ninstall.packages(\"okxAPI\")\n```\n\nAnd the development version from [GitHub](https://github.com/) with:\n\n``` r\n# install.packages(\"devtools\")\ndevtools::install_github(\"fanggong/okxAPI\")\n```\n\n## Requirements\n\nPlease refer to [okx my api page](https://www.okx.com/account/my-api) regarding V5 API Key creation.\n\n## Example\n\n### REST API\n\nYou can implement all REST API requests in Okx exchange by inheriting the `restAPI` class. For example, to implement [Get currencies](https://www.okx.com/docs-v5/en/#rest-api-funding-get-currencies), you can define the class and call the method as follows:\n\n``` r\nmyRestAPI <- R6::R6Class(\n inherit = restAPI,\n public = list(\n get_currencies = function(ccy, process = \"identity\") {\n self$get_result(\n api = \"/api/v5/asset/currencies\", method = \"GET\", process = process,\n ccy = ccy\n )\n }\n )\n)\ntmp <- myRestAPI$new(api_key, secret_key, passphrase)\ntmp$get_currencies(\"BTC\")\n```\n\nFor commonly used interfaces, they have been implemented in this package. The naming convention is as follows: for \"/api/v5/AAA/BBB\", a new class named `restAPIAAA`, which inherits from `restAPI`, has been defined in this package. The `BBB` method in this new class is used to call the API.\n\n### WebSocket API Public Channel\n\nA `websocketAPIpublic` class based on [websocket package](https://github.com/rstudio/websocket) is used here.\n\nCreate new `websocketAPIpublic` object and initiate the connection to the server.\n\n``` r\ntmp <- websocketAPIpublic$new()\ntmp$connect()\n```\n\nSubscribe BTC-USDT-SWAP 5m candlesticks data.\n\n``` r\nmsg <- list(\n op = \"subscribe\",\n args = list(\n list(channel = \"candle5m\", instId = \"BTC-USDT-SWAP\")\n )\n)\nmsg <- jsonlite::toJSON(msg, auto_unbox = TRUE, pretty = TRUE)\ntmp$send(msg)\n```\n\nPass your own callback function\n\n``` r\ntmp$on_message(function(event) {\n if (event$data == \"pong\") {\n cat(\"Bingo!!\")\n }\n})\ntmp$send(\"ping\")\n```\n\nClose the connection.\n\n``` r\ntmp$close()\n```\n\n### WebSocket API Private Channel\n\nA `websocketAPIprivate` class based on [websocket package](https://github.com/rstudio/websocket) is used here.\n\nCreate new `websocketAPIprivate` object and initiate the connection to the server.\n\n``` r\ntmp <- websocketAPIprivate$new(api_key, secret_key, passphrase)\ntmp$connect()\nSys.sleep(1) # Waiting for connection success\ntmp$login()\n```\n\nSubscribe account information.\n\n``` r\nmsg <- list(\n op = \"subscribe\",\n args = list(\n list(channel = \"account\", ccy = \"USDT\")\n )\n)\nmsg <- jsonlite::toJSON(msg, auto_unbox = TRUE, pretty = TRUE)\ntmp$send(msg)\n```\n\nPass your own callback function.\n\n``` r\ntmp$on_message(function(event) {\n if (event$data == \"pong\") {\n cat(\"Bingo!!\")\n }\n})\ntmp$send(\"ping\")\n```\n\nClose the connection.\n\n``` r\ntmp$close()\n```","jobInfo":{"package":"okxAPI","version":"0.1.1","parsingStatus":"success","parserVersion":2,"parsedAt":"2023-04-22T09:29:57+0000"}}

Description

Arguments

See Also