From 29ef27d30d74b685db5d2ecc73e2e71af39dd21b Mon Sep 17 00:00:00 2001 From: JKorf Date: Tue, 26 Mar 2024 12:55:21 +0100 Subject: [PATCH] Docs --- ByBit.Net/Icon/icon.png | Bin 4228 -> 4691 bytes .../IBybitRestClientCopyTradingApi.md | 18 - .../IBybitRestClientCopyTradingApiAccount.md | 63 - ...bitRestClientCopyTradingApiExchangeData.md | 58 - .../IBybitRestClientCopyTradingApiTrading.md | 235 - .../IBybitSocketClientCopyTradingApi.md | 109 - .../IBybitRestClientContractApi.md | 16 - .../IBybitRestClientContractApiAccount.md | 378 - .../IBybitRestClientContractApiTrading.md | 240 - .../IBybitSocketClientContractApi.md | 110 - .../IBybitRestClientDerivativesApi.md | 18 - ...bitRestClientDerivativesApiExchangeData.md | 351 - .../IBybitSocketClientDerivativesPublicApi.md | 236 - .../IBybitRestClientUnifiedMarginApi.md | 16 - ...IBybitRestClientUnifiedMarginApiAccount.md | 392 - ...IBybitRestClientUnifiedMarginApiTrading.md | 223 - .../IBybitSocketClientUnifiedMarginApi.md | 135 - .../GeneralApi/IBybitRestClientGeneralApi.md | 15 - .../IBybitRestClientGeneralApiTransfer.md | 279 - ...ybitRestClientGeneralApiWithdrawDeposit.md | 237 - docs/ClientInfo/IBybitRestClient.md | 38 - docs/ClientInfo/IBybitSocketClient.md | 53 - .../IBybitRestClientInverseFuturesApi.md | 18 - ...BybitRestClientInverseFuturesApiAccount.md | 429 - ...RestClientInverseFuturesApiExchangeData.md | 323 - ...BybitRestClientInverseFuturesApiTrading.md | 500 - .../IBybitRestClientInversePerpetualApi.md | 18 - ...bitRestClientInversePerpetualApiAccount.md | 450 - ...stClientInversePerpetualApiExchangeData.md | 376 - ...bitRestClientInversePerpetualApiTrading.md | 498 - .../IBybitSocketClientInversePerpetualApi.md | 611 - .../SpotApi/IBybitSpotRequestValidable.md | 16 - .../v1/IBybitRestClientSpotApiAccountV1.md | 59 - .../IBybitRestClientSpotApiExchangeDataV1.md | 337 - .../v1/IBybitRestClientSpotApiTradingV1.md | 321 - .../SpotApi/v1/IBybitRestClientSpotApiV1.md | 22 - .../SpotApi/v1/IBybitSocketClientSpotApiV1.md | 194 - .../SpotApi/v2/IBybitSocketClientSpotApiV2.md | 169 - .../v3/IBybitRestClientSpotApiAccountV3.md | 59 - .../IBybitRestClientSpotApiExchangeDataV3.md | 337 - .../v3/IBybitRestClientSpotApiTradingV3.md | 326 - .../SpotApi/v3/IBybitRestClientSpotApiV3.md | 22 - .../SpotApi/v3/IBybitSocketClientSpotApiV3.md | 239 - .../IBybitRestClientUsdPerpetualApi.md | 18 - .../IBybitRestClientUsdPerpetualApiAccount.md | 510 - ...itRestClientUsdPerpetualApiExchangeData.md | 375 - .../IBybitRestClientUsdPerpetualApiTrading.md | 506 - .../IBybitSocketClientUsdPerpetualApi.md | 482 - docs/ClientInfo/V5/IBybitRestClientApi.md | 25 - .../V5/IBybitRestClientApiAccount.md | 1105 -- .../V5/IBybitRestClientApiExchangeData.md | 621 - .../V5/IBybitRestClientApiSubAccounts.md | 160 - .../V5/IBybitRestClientApiTrading.md | 659 - .../V5/IBybitSocketClientBaseApi.md | 172 - .../V5/IBybitSocketClientInverseApi.md | 114 - .../V5/IBybitSocketClientLinearApi.md | 114 - .../V5/IBybitSocketClientOptionApi.md | 114 - .../V5/IBybitSocketClientPrivateApi.md | 135 - .../V5/IBybitSocketClientSpotApi.md | 220 - docs/Examples.md | 320 - docs/MigrationGuide.md | 8 - docs/Usage.md | 59 - docs/assets/css/color-blue.css | 159 + docs/assets/css/color-brown.css | 159 + docs/assets/css/color-cyan.css | 159 + docs/assets/css/color-green.css | 159 + docs/assets/css/color-indigo.css | 159 + docs/assets/css/color-orange.css | 159 + docs/assets/css/color-purple.css | 159 + docs/assets/css/color-red.css | 159 + docs/assets/css/color-teal.css | 159 + docs/assets/css/color-yellow.css | 159 + docs/assets/css/stylesheet.css | 2986 +++++ docs/assets/images/logo.png | Bin 0 -> 4691 bytes docs/assets/js/theme.js | 162 + docs/assets/sass/_elements.scss | 537 + docs/assets/sass/_extras.scss | 448 + docs/assets/sass/_footer.scss | 188 + docs/assets/sass/_header.scss | 554 + docs/assets/sass/_helpers.scss | 301 + docs/assets/sass/_layouts.scss | 171 + docs/assets/sass/_mixins.scss | 31 + docs/assets/sass/_reset.scss | 164 + docs/assets/sass/_variables.scss | 44 + docs/assets/sass/bootstrap/_alert.scss | 51 + docs/assets/sass/bootstrap/_badge.scss | 54 + docs/assets/sass/bootstrap/_breadcrumb.scss | 44 + docs/assets/sass/bootstrap/_button-group.scss | 163 + docs/assets/sass/bootstrap/_buttons.scss | 142 + docs/assets/sass/bootstrap/_card.scss | 286 + docs/assets/sass/bootstrap/_carousel.scss | 197 + docs/assets/sass/bootstrap/_close.scss | 40 + docs/assets/sass/bootstrap/_code.scss | 48 + docs/assets/sass/bootstrap/_custom-forms.scss | 523 + docs/assets/sass/bootstrap/_dropdown.scss | 192 + docs/assets/sass/bootstrap/_forms.scss | 347 + docs/assets/sass/bootstrap/_functions.scss | 141 + docs/assets/sass/bootstrap/_grid.scss | 73 + docs/assets/sass/bootstrap/_images.scss | 42 + docs/assets/sass/bootstrap/_input-group.scss | 192 + docs/assets/sass/bootstrap/_jumbotron.scss | 17 + docs/assets/sass/bootstrap/_list-group.scss | 154 + docs/assets/sass/bootstrap/_media.scss | 8 + docs/assets/sass/bootstrap/_mixins.scss | 47 + docs/assets/sass/bootstrap/_modal.scss | 240 + docs/assets/sass/bootstrap/_nav.scss | 123 + docs/assets/sass/bootstrap/_navbar.scss | 324 + docs/assets/sass/bootstrap/_pagination.scss | 74 + docs/assets/sass/bootstrap/_popover.scss | 170 + docs/assets/sass/bootstrap/_print.scss | 141 + docs/assets/sass/bootstrap/_progress.scss | 47 + docs/assets/sass/bootstrap/_reboot.scss | 480 + docs/assets/sass/bootstrap/_root.scss | 20 + docs/assets/sass/bootstrap/_spinners.scss | 56 + docs/assets/sass/bootstrap/_tables.scss | 185 + docs/assets/sass/bootstrap/_toasts.scss | 46 + docs/assets/sass/bootstrap/_tooltip.scss | 115 + docs/assets/sass/bootstrap/_transitions.scss | 20 + docs/assets/sass/bootstrap/_type.scss | 125 + docs/assets/sass/bootstrap/_utilities.scss | 18 + docs/assets/sass/bootstrap/_variables.scss | 1140 ++ .../assets/sass/bootstrap/bootstrap-grid.scss | 29 + .../sass/bootstrap/bootstrap-reboot.scss | 12 + docs/assets/sass/bootstrap/bootstrap.scss | 44 + docs/assets/sass/bootstrap/mixins/_alert.scss | 13 + .../bootstrap/mixins/_background-variant.scss | 23 + docs/assets/sass/bootstrap/mixins/_badge.scss | 17 + .../sass/bootstrap/mixins/_border-radius.scss | 76 + .../sass/bootstrap/mixins/_box-shadow.scss | 20 + .../sass/bootstrap/mixins/_breakpoints.scss | 123 + .../sass/bootstrap/mixins/_buttons.scss | 110 + docs/assets/sass/bootstrap/mixins/_caret.scss | 62 + .../sass/bootstrap/mixins/_clearfix.scss | 7 + .../sass/bootstrap/mixins/_deprecate.scss | 10 + docs/assets/sass/bootstrap/mixins/_float.scss | 14 + docs/assets/sass/bootstrap/mixins/_forms.scss | 178 + .../sass/bootstrap/mixins/_gradients.scss | 45 + .../bootstrap/mixins/_grid-framework.scss | 80 + docs/assets/sass/bootstrap/mixins/_grid.scss | 69 + docs/assets/sass/bootstrap/mixins/_hover.scss | 37 + docs/assets/sass/bootstrap/mixins/_image.scss | 36 + .../sass/bootstrap/mixins/_list-group.scss | 21 + docs/assets/sass/bootstrap/mixins/_lists.scss | 7 + .../sass/bootstrap/mixins/_nav-divider.scss | 11 + .../sass/bootstrap/mixins/_pagination.scss | 22 + .../sass/bootstrap/mixins/_reset-text.scss | 17 + .../assets/sass/bootstrap/mixins/_resize.scss | 6 + .../sass/bootstrap/mixins/_screen-reader.scss | 34 + docs/assets/sass/bootstrap/mixins/_size.scss | 7 + .../sass/bootstrap/mixins/_table-row.scss | 39 + .../sass/bootstrap/mixins/_text-emphasis.scss | 17 + .../sass/bootstrap/mixins/_text-hide.scss | 11 + .../sass/bootstrap/mixins/_text-truncate.scss | 8 + .../sass/bootstrap/mixins/_transition.scss | 26 + .../sass/bootstrap/mixins/_visibility.scss | 8 + .../sass/bootstrap/utilities/_align.scss | 8 + .../sass/bootstrap/utilities/_background.scss | 19 + .../sass/bootstrap/utilities/_borders.scss | 75 + .../sass/bootstrap/utilities/_clearfix.scss | 3 + .../sass/bootstrap/utilities/_display.scss | 26 + .../sass/bootstrap/utilities/_embed.scss | 39 + .../sass/bootstrap/utilities/_flex.scss | 51 + .../sass/bootstrap/utilities/_float.scss | 11 + .../bootstrap/utilities/_interactions.scss | 5 + .../sass/bootstrap/utilities/_overflow.scss | 5 + .../sass/bootstrap/utilities/_position.scss | 32 + .../bootstrap/utilities/_screenreaders.scss | 11 + .../sass/bootstrap/utilities/_shadows.scss | 6 + .../sass/bootstrap/utilities/_sizing.scss | 20 + .../sass/bootstrap/utilities/_spacing.scss | 73 + .../bootstrap/utilities/_stretched-link.scss | 19 + .../sass/bootstrap/utilities/_text.scss | 72 + .../sass/bootstrap/utilities/_visibility.scss | 13 + docs/assets/sass/bootstrap/vendor/_rfs.scss | 204 + docs/assets/sass/color-blue.scss | 191 + docs/assets/sass/color-brown.scss | 191 + docs/assets/sass/color-cyan.scss | 191 + docs/assets/sass/color-green.scss | 191 + docs/assets/sass/color-indigo.scss | 191 + docs/assets/sass/color-orange.scss | 191 + docs/assets/sass/color-purple.scss | 191 + docs/assets/sass/color-red.scss | 191 + docs/assets/sass/color-teal.scss | 191 + docs/assets/sass/color-yellow.scss | 191 + docs/assets/sass/stylesheet.scss | 28 + .../vendor/bootstrap/css/bootstrap-grid.css | 3872 ++++++ .../bootstrap/css/bootstrap-grid.css.map | 1 + .../bootstrap/css/bootstrap-grid.min.css | 7 + .../bootstrap/css/bootstrap-grid.min.css.map | 1 + .../vendor/bootstrap/css/bootstrap-reboot.css | 325 + .../bootstrap/css/bootstrap-reboot.css.map | 1 + .../bootstrap/css/bootstrap-reboot.min.css | 8 + .../css/bootstrap-reboot.min.css.map | 1 + .../assets/vendor/bootstrap/css/bootstrap.css | 10259 ++++++++++++++++ .../vendor/bootstrap/css/bootstrap.css.map | 1 + .../vendor/bootstrap/css/bootstrap.min.css | 7 + .../bootstrap/css/bootstrap.min.css.map | 1 + .../vendor/bootstrap/js/bootstrap.bundle.js | 7023 +++++++++++ .../bootstrap/js/bootstrap.bundle.js.map | 1 + .../bootstrap/js/bootstrap.bundle.min.js | 7 + .../bootstrap/js/bootstrap.bundle.min.js.map | 1 + docs/assets/vendor/bootstrap/js/bootstrap.js | 4410 +++++++ .../vendor/bootstrap/js/bootstrap.js.map | 1 + .../vendor/bootstrap/js/bootstrap.min.js | 7 + .../vendor/bootstrap/js/bootstrap.min.js.map | 1 + docs/assets/vendor/font-awesome/css/all.css | 4463 +++++++ .../vendor/font-awesome/css/all.min.css | 5 + .../assets/vendor/font-awesome/css/brands.css | 16 + .../vendor/font-awesome/css/brands.min.css | 5 + .../vendor/font-awesome/css/fontawesome.css | 4417 +++++++ .../font-awesome/css/fontawesome.min.css | 5 + .../vendor/font-awesome/css/regular.css | 16 + .../vendor/font-awesome/css/regular.min.css | 5 + docs/assets/vendor/font-awesome/css/solid.css | 17 + .../vendor/font-awesome/css/solid.min.css | 5 + .../vendor/font-awesome/css/svg-with-js.css | 371 + .../font-awesome/css/svg-with-js.min.css | 5 + .../vendor/font-awesome/css/v4-shims.css | 2173 ++++ .../vendor/font-awesome/css/v4-shims.min.css | 5 + docs/assets/vendor/font-awesome/js/all.js | 4391 +++++++ docs/assets/vendor/font-awesome/js/all.min.js | 5 + docs/assets/vendor/font-awesome/js/brands.js | 571 + .../vendor/font-awesome/js/brands.min.js | 5 + .../font-awesome/js/conflict-detection.js | 998 ++ .../font-awesome/js/conflict-detection.min.js | 5 + .../vendor/font-awesome/js/fontawesome.js | 2459 ++++ .../vendor/font-awesome/js/fontawesome.min.js | 5 + docs/assets/vendor/font-awesome/js/regular.js | 280 + .../vendor/font-awesome/js/regular.min.js | 5 + docs/assets/vendor/font-awesome/js/solid.js | 1093 ++ .../vendor/font-awesome/js/solid.min.js | 5 + .../assets/vendor/font-awesome/js/v4-shims.js | 68 + .../vendor/font-awesome/js/v4-shims.min.js | 5 + .../font-awesome/webfonts/fa-brands-400.eot | Bin 0 -> 133034 bytes .../font-awesome/webfonts/fa-brands-400.svg | 3570 ++++++ .../font-awesome/webfonts/fa-brands-400.ttf | Bin 0 -> 132728 bytes .../font-awesome/webfonts/fa-brands-400.woff | Bin 0 -> 89824 bytes .../font-awesome/webfonts/fa-brands-400.woff2 | Bin 0 -> 76548 bytes .../font-awesome/webfonts/fa-regular-400.eot | Bin 0 -> 34390 bytes .../font-awesome/webfonts/fa-regular-400.svg | 803 ++ .../font-awesome/webfonts/fa-regular-400.ttf | Bin 0 -> 34092 bytes .../font-awesome/webfonts/fa-regular-400.woff | Bin 0 -> 16800 bytes .../webfonts/fa-regular-400.woff2 | Bin 0 -> 13600 bytes .../font-awesome/webfonts/fa-solid-900.eot | Bin 0 -> 194078 bytes .../font-awesome/webfonts/fa-solid-900.svg | 4700 +++++++ .../font-awesome/webfonts/fa-solid-900.ttf | Bin 0 -> 193792 bytes .../font-awesome/webfonts/fa-solid-900.woff | Bin 0 -> 99004 bytes .../font-awesome/webfonts/fa-solid-900.woff2 | Bin 0 -> 76120 bytes docs/assets/vendor/highlight.js/highlight.js | 750 ++ .../vendor/highlight.js/highlight.min.js | 44 + .../vendor/highlight.js/languages/1c.js | 519 + .../vendor/highlight.js/languages/abnf.js | 74 + .../highlight.js/languages/accesslog.js | 72 + .../highlight.js/languages/actionscript.js | 80 + .../vendor/highlight.js/languages/ada.js | 182 + .../highlight.js/languages/angelscript.js | 114 + .../vendor/highlight.js/languages/apache.js | 73 + .../highlight.js/languages/applescript.js | 93 + .../vendor/highlight.js/languages/arcade.js | 145 + .../vendor/highlight.js/languages/arduino.js | 108 + .../vendor/highlight.js/languages/armasm.js | 108 + .../vendor/highlight.js/languages/asciidoc.js | 197 + .../vendor/highlight.js/languages/aspectj.js | 151 + .../highlight.js/languages/autohotkey.js | 65 + .../vendor/highlight.js/languages/autoit.js | 143 + .../vendor/highlight.js/languages/avrasm.js | 69 + .../vendor/highlight.js/languages/awk.js | 60 + .../vendor/highlight.js/languages/axapta.js | 38 + .../vendor/highlight.js/languages/bash.js | 122 + .../vendor/highlight.js/languages/basic.js | 58 + .../vendor/highlight.js/languages/bnf.js | 33 + .../highlight.js/languages/brainfuck.js | 43 + .../vendor/highlight.js/languages/c-like.js | 239 + .../assets/vendor/highlight.js/languages/c.js | 22 + .../vendor/highlight.js/languages/cal.js | 87 + .../highlight.js/languages/capnproto.js | 57 + .../vendor/highlight.js/languages/ceylon.js | 72 + .../vendor/highlight.js/languages/clean.js | 34 + .../highlight.js/languages/clojure-repl.js | 24 + .../vendor/highlight.js/languages/clojure.js | 122 + .../vendor/highlight.js/languages/cmake.js | 60 + .../highlight.js/languages/coffeescript.js | 179 + .../vendor/highlight.js/languages/coq.js | 74 + .../vendor/highlight.js/languages/cos.js | 130 + .../vendor/highlight.js/languages/cpp.js | 16 + .../vendor/highlight.js/languages/crmsh.js | 102 + .../vendor/highlight.js/languages/crystal.js | 194 + .../vendor/highlight.js/languages/csharp.js | 208 + .../vendor/highlight.js/languages/csp.js | 31 + .../vendor/highlight.js/languages/css.js | 132 + .../assets/vendor/highlight.js/languages/d.js | 267 + .../vendor/highlight.js/languages/dart.js | 134 + .../vendor/highlight.js/languages/delphi.js | 94 + .../vendor/highlight.js/languages/diff.js | 48 + .../vendor/highlight.js/languages/django.js | 74 + .../vendor/highlight.js/languages/dns.js | 36 + .../highlight.js/languages/dockerfile.js | 31 + .../vendor/highlight.js/languages/dos.js | 59 + .../vendor/highlight.js/languages/dsconfig.js | 52 + .../vendor/highlight.js/languages/dts.js | 133 + .../vendor/highlight.js/languages/dust.js | 41 + .../vendor/highlight.js/languages/ebnf.js | 46 + .../vendor/highlight.js/languages/elixir.js | 181 + .../vendor/highlight.js/languages/elm.js | 97 + .../vendor/highlight.js/languages/erb.js | 25 + .../highlight.js/languages/erlang-repl.js | 53 + .../vendor/highlight.js/languages/erlang.js | 155 + .../vendor/highlight.js/languages/excel.js | 55 + .../vendor/highlight.js/languages/fix.js | 34 + .../vendor/highlight.js/languages/flix.js | 52 + .../vendor/highlight.js/languages/fortran.js | 105 + .../vendor/highlight.js/languages/fsharp.js | 66 + .../vendor/highlight.js/languages/gams.js | 164 + .../vendor/highlight.js/languages/gauss.js | 298 + .../vendor/highlight.js/languages/gcode.js | 75 + .../vendor/highlight.js/languages/gherkin.js | 44 + .../vendor/highlight.js/languages/glsl.js | 125 + .../vendor/highlight.js/languages/gml.js | 881 ++ .../vendor/highlight.js/languages/go.js | 63 + .../vendor/highlight.js/languages/golo.js | 30 + .../vendor/highlight.js/languages/gradle.js | 42 + .../vendor/highlight.js/languages/groovy.js | 101 + .../vendor/highlight.js/languages/haml.js | 115 + .../highlight.js/languages/handlebars.js | 84 + .../vendor/highlight.js/languages/haskell.js | 130 + .../vendor/highlight.js/languages/haxe.js | 120 + .../vendor/highlight.js/languages/hsp.js | 55 + .../vendor/highlight.js/languages/htmlbars.js | 86 + .../vendor/highlight.js/languages/http.js | 49 + .../vendor/highlight.js/languages/hy.js | 105 + .../vendor/highlight.js/languages/inform7.js | 64 + .../vendor/highlight.js/languages/ini.js | 85 + .../vendor/highlight.js/languages/irpf90.js | 85 + .../vendor/highlight.js/languages/isbl.js | 3178 +++++ .../vendor/highlight.js/languages/java.js | 125 + .../highlight.js/languages/javascript.js | 284 + .../highlight.js/languages/jboss-cli.js | 55 + .../vendor/highlight.js/languages/json.js | 52 + .../highlight.js/languages/julia-repl.js | 48 + .../vendor/highlight.js/languages/julia.js | 171 + .../vendor/highlight.js/languages/kotlin.js | 226 + .../vendor/highlight.js/languages/lasso.js | 169 + .../vendor/highlight.js/languages/latex.js | 70 + .../vendor/highlight.js/languages/ldif.js | 29 + .../vendor/highlight.js/languages/leaf.js | 46 + .../vendor/highlight.js/languages/less.js | 148 + .../highlight.js/languages/lib/ecmascript.js | 139 + .../vendor/highlight.js/languages/lisp.js | 106 + .../highlight.js/languages/livecodeserver.js | 170 + .../highlight.js/languages/livescript.js | 198 + .../vendor/highlight.js/languages/llvm.js | 96 + .../vendor/highlight.js/languages/lsl.js | 92 + .../vendor/highlight.js/languages/lua.js | 74 + .../vendor/highlight.js/languages/makefile.js | 84 + .../vendor/highlight.js/languages/markdown.js | 155 + .../highlight.js/languages/mathematica.js | 59 + .../vendor/highlight.js/languages/matlab.js | 104 + .../vendor/highlight.js/languages/maxima.js | 414 + .../vendor/highlight.js/languages/mel.js | 233 + .../vendor/highlight.js/languages/mercury.js | 91 + .../vendor/highlight.js/languages/mipsasm.js | 95 + .../vendor/highlight.js/languages/mizar.js | 27 + .../highlight.js/languages/mojolicious.js | 33 + .../vendor/highlight.js/languages/monkey.js | 82 + .../highlight.js/languages/moonscript.js | 121 + .../vendor/highlight.js/languages/n1ql.js | 77 + .../vendor/highlight.js/languages/nginx.js | 101 + .../vendor/highlight.js/languages/nim.js | 62 + .../vendor/highlight.js/languages/nix.js | 57 + .../vendor/highlight.js/languages/nsis.js | 113 + .../highlight.js/languages/objectivec.js | 107 + .../vendor/highlight.js/languages/ocaml.js | 80 + .../vendor/highlight.js/languages/openscad.js | 65 + .../vendor/highlight.js/languages/oxygene.js | 79 + .../vendor/highlight.js/languages/parser3.js | 56 + .../vendor/highlight.js/languages/perl.js | 166 + .../vendor/highlight.js/languages/pf.js | 60 + .../vendor/highlight.js/languages/pgsql.js | 506 + .../highlight.js/languages/php-template.js | 30 + .../vendor/highlight.js/languages/php.js | 160 + .../highlight.js/languages/plaintext.js | 14 + .../vendor/highlight.js/languages/pony.js | 83 + .../highlight.js/languages/powershell.js | 260 + .../highlight.js/languages/processing.js | 56 + .../vendor/highlight.js/languages/profile.js | 36 + .../vendor/highlight.js/languages/prolog.js | 95 + .../highlight.js/languages/properties.js | 77 + .../vendor/highlight.js/languages/protobuf.js | 44 + .../vendor/highlight.js/languages/puppet.js | 122 + .../highlight.js/languages/purebasic.js | 93 + .../highlight.js/languages/python-repl.js | 29 + .../vendor/highlight.js/languages/python.js | 137 + .../assets/vendor/highlight.js/languages/q.js | 30 + .../vendor/highlight.js/languages/qml.js | 179 + .../assets/vendor/highlight.js/languages/r.js | 78 + .../vendor/highlight.js/languages/reasonml.js | 307 + .../vendor/highlight.js/languages/rib.js | 35 + .../vendor/highlight.js/languages/roboconf.js | 75 + .../vendor/highlight.js/languages/routeros.js | 170 + .../vendor/highlight.js/languages/rsl.js | 44 + .../vendor/highlight.js/languages/ruby.js | 194 + .../highlight.js/languages/ruleslanguage.js | 69 + .../vendor/highlight.js/languages/rust.js | 116 + .../vendor/highlight.js/languages/sas.js | 132 + .../vendor/highlight.js/languages/scala.js | 123 + .../vendor/highlight.js/languages/scheme.js | 149 + .../vendor/highlight.js/languages/scilab.js | 63 + .../vendor/highlight.js/languages/scss.js | 122 + .../vendor/highlight.js/languages/shell.js | 22 + .../vendor/highlight.js/languages/smali.js | 63 + .../highlight.js/languages/smalltalk.js | 57 + .../vendor/highlight.js/languages/sml.js | 74 + .../vendor/highlight.js/languages/sqf.js | 436 + .../vendor/highlight.js/languages/sql.js | 168 + .../vendor/highlight.js/languages/stan.js | 228 + .../vendor/highlight.js/languages/stata.js | 51 + .../vendor/highlight.js/languages/step21.js | 54 + .../vendor/highlight.js/languages/stylus.js | 453 + .../vendor/highlight.js/languages/subunit.js | 40 + .../vendor/highlight.js/languages/swift.js | 141 + .../highlight.js/languages/taggerscript.js | 50 + .../vendor/highlight.js/languages/tap.js | 44 + .../vendor/highlight.js/languages/tcl.js | 67 + .../vendor/highlight.js/languages/thrift.js | 43 + .../vendor/highlight.js/languages/tp.js | 91 + .../vendor/highlight.js/languages/twig.js | 75 + .../highlight.js/languages/typescript.js | 229 + .../vendor/highlight.js/languages/vala.js | 57 + .../vendor/highlight.js/languages/vbnet.js | 63 + .../highlight.js/languages/vbscript-html.js | 21 + .../vendor/highlight.js/languages/vbscript.js | 48 + .../vendor/highlight.js/languages/verilog.js | 108 + .../vendor/highlight.js/languages/vhdl.js | 69 + .../vendor/highlight.js/languages/vim.js | 118 + .../vendor/highlight.js/languages/x86asm.js | 144 + .../vendor/highlight.js/languages/xl.js | 80 + .../vendor/highlight.js/languages/xml.js | 139 + .../vendor/highlight.js/languages/xquery.js | 180 + .../vendor/highlight.js/languages/yaml.js | 174 + .../vendor/highlight.js/languages/zephir.js | 117 + .../vendor/highlight.js/lib/html_renderer.js | 46 + .../vendor/highlight.js/lib/mode_compiler.js | 354 + docs/assets/vendor/highlight.js/lib/modes.js | 148 + docs/assets/vendor/highlight.js/lib/regex.js | 74 + .../vendor/highlight.js/lib/response.js | 11 + .../vendor/highlight.js/lib/token_tree.js | 121 + docs/assets/vendor/highlight.js/lib/utils.js | 135 + .../vendor/highlight.js/styles/a11y-dark.css | 99 + .../vendor/highlight.js/styles/a11y-light.css | 99 + .../vendor/highlight.js/styles/agate.css | 108 + .../highlight.js/styles/an-old-hope.css | 89 + .../highlight.js/styles/androidstudio.css | 66 + .../highlight.js/styles/arduino-light.css | 87 + .../vendor/highlight.js/styles/arta.css | 73 + .../vendor/highlight.js/styles/ascetic.css | 45 + .../highlight.js/styles/atelier-cave-dark.css | 83 + .../styles/atelier-cave-light.css | 85 + .../highlight.js/styles/atelier-dune-dark.css | 69 + .../styles/atelier-dune-light.css | 69 + .../styles/atelier-estuary-dark.css | 84 + .../styles/atelier-estuary-light.css | 84 + .../styles/atelier-forest-dark.css | 69 + .../styles/atelier-forest-light.css | 69 + .../styles/atelier-heath-dark.css | 69 + .../styles/atelier-heath-light.css | 69 + .../styles/atelier-lakeside-dark.css | 69 + .../styles/atelier-lakeside-light.css | 69 + .../styles/atelier-plateau-dark.css | 84 + .../styles/atelier-plateau-light.css | 84 + .../styles/atelier-savanna-dark.css | 84 + .../styles/atelier-savanna-light.css | 84 + .../styles/atelier-seaside-dark.css | 69 + .../styles/atelier-seaside-light.css | 69 + .../styles/atelier-sulphurpool-dark.css | 69 + .../styles/atelier-sulphurpool-light.css | 69 + .../styles/atom-one-dark-reasonable.css | 75 + .../highlight.js/styles/atom-one-dark.css | 96 + .../highlight.js/styles/atom-one-light.css | 96 + .../highlight.js/styles/brown-paper.css | 64 + .../highlight.js/styles/brown-papersq.png | Bin 0 -> 18198 bytes .../highlight.js/styles/codepen-embed.css | 60 + .../highlight.js/styles/color-brewer.css | 71 + .../vendor/highlight.js/styles/darcula.css | 74 + .../vendor/highlight.js/styles/dark.css | 63 + .../vendor/highlight.js/styles/default.css | 99 + .../vendor/highlight.js/styles/docco.css | 97 + .../vendor/highlight.js/styles/dracula.css | 76 + .../assets/vendor/highlight.js/styles/far.css | 71 + .../vendor/highlight.js/styles/foundation.css | 89 + .../highlight.js/styles/github-gist.css | 79 + .../vendor/highlight.js/styles/github.css | 99 + .../assets/vendor/highlight.js/styles/gml.css | 78 + .../vendor/highlight.js/styles/googlecode.css | 89 + .../highlight.js/styles/gradient-dark.css | 122 + .../vendor/highlight.js/styles/grayscale.css | 101 + .../highlight.js/styles/gruvbox-dark.css | 108 + .../highlight.js/styles/gruvbox-light.css | 108 + .../vendor/highlight.js/styles/hopscotch.css | 84 + .../vendor/highlight.js/styles/hybrid.css | 102 + .../vendor/highlight.js/styles/idea.css | 97 + .../vendor/highlight.js/styles/ir-black.css | 73 + .../highlight.js/styles/isbl-editor-dark.css | 112 + .../highlight.js/styles/isbl-editor-light.css | 111 + .../highlight.js/styles/kimbie.dark.css | 74 + .../highlight.js/styles/kimbie.light.css | 74 + .../vendor/highlight.js/styles/lightfair.css | 88 + .../vendor/highlight.js/styles/magula.css | 70 + .../vendor/highlight.js/styles/mono-blue.css | 56 + .../highlight.js/styles/monokai-sublime.css | 83 + .../vendor/highlight.js/styles/monokai.css | 71 + .../vendor/highlight.js/styles/night-owl.css | 182 + .../vendor/highlight.js/styles/nord.css | 309 + .../vendor/highlight.js/styles/obsidian.css | 88 + .../vendor/highlight.js/styles/ocean.css | 74 + .../highlight.js/styles/paraiso-dark.css | 72 + .../highlight.js/styles/paraiso-light.css | 72 + .../vendor/highlight.js/styles/pojoaque.css | 83 + .../vendor/highlight.js/styles/pojoaque.jpg | Bin 0 -> 1186 bytes .../vendor/highlight.js/styles/purebasic.css | 96 + .../highlight.js/styles/qtcreator_dark.css | 83 + .../highlight.js/styles/qtcreator_light.css | 83 + .../vendor/highlight.js/styles/railscasts.css | 106 + .../vendor/highlight.js/styles/rainbow.css | 85 + .../vendor/highlight.js/styles/routeros.css | 108 + .../highlight.js/styles/school-book.css | 69 + .../highlight.js/styles/school-book.png | Bin 0 -> 486 bytes .../highlight.js/styles/shades-of-purple.css | 96 + .../highlight.js/styles/solarized-dark.css | 84 + .../highlight.js/styles/solarized-light.css | 84 + .../vendor/highlight.js/styles/srcery.css | 78 + .../vendor/highlight.js/styles/sunburst.css | 102 + .../styles/tomorrow-night-blue.css | 75 + .../styles/tomorrow-night-bright.css | 74 + .../styles/tomorrow-night-eighties.css | 74 + .../highlight.js/styles/tomorrow-night.css | 75 + .../vendor/highlight.js/styles/tomorrow.css | 72 + docs/assets/vendor/highlight.js/styles/vs.css | 68 + .../vendor/highlight.js/styles/vs2015.css | 115 + .../vendor/highlight.js/styles/xcode.css | 104 + .../vendor/highlight.js/styles/xt256.css | 92 + .../vendor/highlight.js/styles/zenburn.css | 80 + .../vendor/highlight.js/vendor/deep_freeze.js | 20 + .../vendor/jquery.easing/jquery.easing.js | 168 + .../vendor/jquery.easing/jquery.easing.min.js | 1 + docs/assets/vendor/jquery/jquery.min.js | 2 + .../magnific-popup/jquery.magnific-popup.js | 1860 +++ .../jquery.magnific-popup.min.js | 4 + .../vendor/magnific-popup/magnific-popup.css | 385 + .../magnific-popup/magnific-popup.min.css | 1 + docs/index.html | 376 + docs/index.md | 27 - 551 files changed, 110198 insertions(+), 14288 deletions(-) delete mode 100644 docs/ClientInfo/CopyTradingApi/IBybitRestClientCopyTradingApi.md delete mode 100644 docs/ClientInfo/CopyTradingApi/IBybitRestClientCopyTradingApiAccount.md delete mode 100644 docs/ClientInfo/CopyTradingApi/IBybitRestClientCopyTradingApiExchangeData.md delete mode 100644 docs/ClientInfo/CopyTradingApi/IBybitRestClientCopyTradingApiTrading.md delete mode 100644 docs/ClientInfo/CopyTradingApi/IBybitSocketClientCopyTradingApi.md delete mode 100644 docs/ClientInfo/DerivativesApi/ContractApi/IBybitRestClientContractApi.md delete mode 100644 docs/ClientInfo/DerivativesApi/ContractApi/IBybitRestClientContractApiAccount.md delete mode 100644 docs/ClientInfo/DerivativesApi/ContractApi/IBybitRestClientContractApiTrading.md delete mode 100644 docs/ClientInfo/DerivativesApi/ContractApi/IBybitSocketClientContractApi.md delete mode 100644 docs/ClientInfo/DerivativesApi/IBybitRestClientDerivativesApi.md delete mode 100644 docs/ClientInfo/DerivativesApi/IBybitRestClientDerivativesApiExchangeData.md delete mode 100644 docs/ClientInfo/DerivativesApi/IBybitSocketClientDerivativesPublicApi.md delete mode 100644 docs/ClientInfo/DerivativesApi/UnifiedMarginApi/IBybitRestClientUnifiedMarginApi.md delete mode 100644 docs/ClientInfo/DerivativesApi/UnifiedMarginApi/IBybitRestClientUnifiedMarginApiAccount.md delete mode 100644 docs/ClientInfo/DerivativesApi/UnifiedMarginApi/IBybitRestClientUnifiedMarginApiTrading.md delete mode 100644 docs/ClientInfo/DerivativesApi/UnifiedMarginApi/IBybitSocketClientUnifiedMarginApi.md delete mode 100644 docs/ClientInfo/GeneralApi/IBybitRestClientGeneralApi.md delete mode 100644 docs/ClientInfo/GeneralApi/IBybitRestClientGeneralApiTransfer.md delete mode 100644 docs/ClientInfo/GeneralApi/IBybitRestClientGeneralApiWithdrawDeposit.md delete mode 100644 docs/ClientInfo/IBybitRestClient.md delete mode 100644 docs/ClientInfo/IBybitSocketClient.md delete mode 100644 docs/ClientInfo/InverseFuturesApi/IBybitRestClientInverseFuturesApi.md delete mode 100644 docs/ClientInfo/InverseFuturesApi/IBybitRestClientInverseFuturesApiAccount.md delete mode 100644 docs/ClientInfo/InverseFuturesApi/IBybitRestClientInverseFuturesApiExchangeData.md delete mode 100644 docs/ClientInfo/InverseFuturesApi/IBybitRestClientInverseFuturesApiTrading.md delete mode 100644 docs/ClientInfo/InversePerpetualApi/IBybitRestClientInversePerpetualApi.md delete mode 100644 docs/ClientInfo/InversePerpetualApi/IBybitRestClientInversePerpetualApiAccount.md delete mode 100644 docs/ClientInfo/InversePerpetualApi/IBybitRestClientInversePerpetualApiExchangeData.md delete mode 100644 docs/ClientInfo/InversePerpetualApi/IBybitRestClientInversePerpetualApiTrading.md delete mode 100644 docs/ClientInfo/InversePerpetualApi/IBybitSocketClientInversePerpetualApi.md delete mode 100644 docs/ClientInfo/SpotApi/IBybitSpotRequestValidable.md delete mode 100644 docs/ClientInfo/SpotApi/v1/IBybitRestClientSpotApiAccountV1.md delete mode 100644 docs/ClientInfo/SpotApi/v1/IBybitRestClientSpotApiExchangeDataV1.md delete mode 100644 docs/ClientInfo/SpotApi/v1/IBybitRestClientSpotApiTradingV1.md delete mode 100644 docs/ClientInfo/SpotApi/v1/IBybitRestClientSpotApiV1.md delete mode 100644 docs/ClientInfo/SpotApi/v1/IBybitSocketClientSpotApiV1.md delete mode 100644 docs/ClientInfo/SpotApi/v2/IBybitSocketClientSpotApiV2.md delete mode 100644 docs/ClientInfo/SpotApi/v3/IBybitRestClientSpotApiAccountV3.md delete mode 100644 docs/ClientInfo/SpotApi/v3/IBybitRestClientSpotApiExchangeDataV3.md delete mode 100644 docs/ClientInfo/SpotApi/v3/IBybitRestClientSpotApiTradingV3.md delete mode 100644 docs/ClientInfo/SpotApi/v3/IBybitRestClientSpotApiV3.md delete mode 100644 docs/ClientInfo/SpotApi/v3/IBybitSocketClientSpotApiV3.md delete mode 100644 docs/ClientInfo/UsdPerpetualApi/IBybitRestClientUsdPerpetualApi.md delete mode 100644 docs/ClientInfo/UsdPerpetualApi/IBybitRestClientUsdPerpetualApiAccount.md delete mode 100644 docs/ClientInfo/UsdPerpetualApi/IBybitRestClientUsdPerpetualApiExchangeData.md delete mode 100644 docs/ClientInfo/UsdPerpetualApi/IBybitRestClientUsdPerpetualApiTrading.md delete mode 100644 docs/ClientInfo/UsdPerpetualApi/IBybitSocketClientUsdPerpetualApi.md delete mode 100644 docs/ClientInfo/V5/IBybitRestClientApi.md delete mode 100644 docs/ClientInfo/V5/IBybitRestClientApiAccount.md delete mode 100644 docs/ClientInfo/V5/IBybitRestClientApiExchangeData.md delete mode 100644 docs/ClientInfo/V5/IBybitRestClientApiSubAccounts.md delete mode 100644 docs/ClientInfo/V5/IBybitRestClientApiTrading.md delete mode 100644 docs/ClientInfo/V5/IBybitSocketClientBaseApi.md delete mode 100644 docs/ClientInfo/V5/IBybitSocketClientInverseApi.md delete mode 100644 docs/ClientInfo/V5/IBybitSocketClientLinearApi.md delete mode 100644 docs/ClientInfo/V5/IBybitSocketClientOptionApi.md delete mode 100644 docs/ClientInfo/V5/IBybitSocketClientPrivateApi.md delete mode 100644 docs/ClientInfo/V5/IBybitSocketClientSpotApi.md delete mode 100644 docs/Examples.md delete mode 100644 docs/MigrationGuide.md delete mode 100644 docs/Usage.md create mode 100644 docs/assets/css/color-blue.css create mode 100644 docs/assets/css/color-brown.css create mode 100644 docs/assets/css/color-cyan.css create mode 100644 docs/assets/css/color-green.css create mode 100644 docs/assets/css/color-indigo.css create mode 100644 docs/assets/css/color-orange.css create mode 100644 docs/assets/css/color-purple.css create mode 100644 docs/assets/css/color-red.css create mode 100644 docs/assets/css/color-teal.css create mode 100644 docs/assets/css/color-yellow.css create mode 100644 docs/assets/css/stylesheet.css create mode 100644 docs/assets/images/logo.png create mode 100644 docs/assets/js/theme.js create mode 100644 docs/assets/sass/_elements.scss create mode 100644 docs/assets/sass/_extras.scss create mode 100644 docs/assets/sass/_footer.scss create mode 100644 docs/assets/sass/_header.scss create mode 100644 docs/assets/sass/_helpers.scss create mode 100644 docs/assets/sass/_layouts.scss create mode 100644 docs/assets/sass/_mixins.scss create mode 100644 docs/assets/sass/_reset.scss create mode 100644 docs/assets/sass/_variables.scss create mode 100644 docs/assets/sass/bootstrap/_alert.scss create mode 100644 docs/assets/sass/bootstrap/_badge.scss create mode 100644 docs/assets/sass/bootstrap/_breadcrumb.scss create mode 100644 docs/assets/sass/bootstrap/_button-group.scss create mode 100644 docs/assets/sass/bootstrap/_buttons.scss create mode 100644 docs/assets/sass/bootstrap/_card.scss create mode 100644 docs/assets/sass/bootstrap/_carousel.scss create mode 100644 docs/assets/sass/bootstrap/_close.scss create mode 100644 docs/assets/sass/bootstrap/_code.scss create mode 100644 docs/assets/sass/bootstrap/_custom-forms.scss create mode 100644 docs/assets/sass/bootstrap/_dropdown.scss create mode 100644 docs/assets/sass/bootstrap/_forms.scss create mode 100644 docs/assets/sass/bootstrap/_functions.scss create mode 100644 docs/assets/sass/bootstrap/_grid.scss create mode 100644 docs/assets/sass/bootstrap/_images.scss create mode 100644 docs/assets/sass/bootstrap/_input-group.scss create mode 100644 docs/assets/sass/bootstrap/_jumbotron.scss create mode 100644 docs/assets/sass/bootstrap/_list-group.scss create mode 100644 docs/assets/sass/bootstrap/_media.scss create mode 100644 docs/assets/sass/bootstrap/_mixins.scss create mode 100644 docs/assets/sass/bootstrap/_modal.scss create mode 100644 docs/assets/sass/bootstrap/_nav.scss create mode 100644 docs/assets/sass/bootstrap/_navbar.scss create mode 100644 docs/assets/sass/bootstrap/_pagination.scss create mode 100644 docs/assets/sass/bootstrap/_popover.scss create mode 100644 docs/assets/sass/bootstrap/_print.scss create mode 100644 docs/assets/sass/bootstrap/_progress.scss create mode 100644 docs/assets/sass/bootstrap/_reboot.scss create mode 100644 docs/assets/sass/bootstrap/_root.scss create mode 100644 docs/assets/sass/bootstrap/_spinners.scss create mode 100644 docs/assets/sass/bootstrap/_tables.scss create mode 100644 docs/assets/sass/bootstrap/_toasts.scss create mode 100644 docs/assets/sass/bootstrap/_tooltip.scss create mode 100644 docs/assets/sass/bootstrap/_transitions.scss create mode 100644 docs/assets/sass/bootstrap/_type.scss create mode 100644 docs/assets/sass/bootstrap/_utilities.scss create mode 100644 docs/assets/sass/bootstrap/_variables.scss create mode 100644 docs/assets/sass/bootstrap/bootstrap-grid.scss create mode 100644 docs/assets/sass/bootstrap/bootstrap-reboot.scss create mode 100644 docs/assets/sass/bootstrap/bootstrap.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_alert.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_background-variant.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_badge.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_border-radius.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_box-shadow.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_breakpoints.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_buttons.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_caret.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_clearfix.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_deprecate.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_float.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_forms.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_gradients.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_grid-framework.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_grid.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_hover.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_image.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_list-group.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_lists.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_nav-divider.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_pagination.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_reset-text.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_resize.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_screen-reader.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_size.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_table-row.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_text-emphasis.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_text-hide.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_text-truncate.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_transition.scss create mode 100644 docs/assets/sass/bootstrap/mixins/_visibility.scss create mode 100644 docs/assets/sass/bootstrap/utilities/_align.scss create mode 100644 docs/assets/sass/bootstrap/utilities/_background.scss create mode 100644 docs/assets/sass/bootstrap/utilities/_borders.scss create mode 100644 docs/assets/sass/bootstrap/utilities/_clearfix.scss create mode 100644 docs/assets/sass/bootstrap/utilities/_display.scss create mode 100644 docs/assets/sass/bootstrap/utilities/_embed.scss create mode 100644 docs/assets/sass/bootstrap/utilities/_flex.scss create mode 100644 docs/assets/sass/bootstrap/utilities/_float.scss create mode 100644 docs/assets/sass/bootstrap/utilities/_interactions.scss create mode 100644 docs/assets/sass/bootstrap/utilities/_overflow.scss create mode 100644 docs/assets/sass/bootstrap/utilities/_position.scss create mode 100644 docs/assets/sass/bootstrap/utilities/_screenreaders.scss create mode 100644 docs/assets/sass/bootstrap/utilities/_shadows.scss create mode 100644 docs/assets/sass/bootstrap/utilities/_sizing.scss create mode 100644 docs/assets/sass/bootstrap/utilities/_spacing.scss create mode 100644 docs/assets/sass/bootstrap/utilities/_stretched-link.scss create mode 100644 docs/assets/sass/bootstrap/utilities/_text.scss create mode 100644 docs/assets/sass/bootstrap/utilities/_visibility.scss create mode 100644 docs/assets/sass/bootstrap/vendor/_rfs.scss create mode 100644 docs/assets/sass/color-blue.scss create mode 100644 docs/assets/sass/color-brown.scss create mode 100644 docs/assets/sass/color-cyan.scss create mode 100644 docs/assets/sass/color-green.scss create mode 100644 docs/assets/sass/color-indigo.scss create mode 100644 docs/assets/sass/color-orange.scss create mode 100644 docs/assets/sass/color-purple.scss create mode 100644 docs/assets/sass/color-red.scss create mode 100644 docs/assets/sass/color-teal.scss create mode 100644 docs/assets/sass/color-yellow.scss create mode 100644 docs/assets/sass/stylesheet.scss create mode 100644 docs/assets/vendor/bootstrap/css/bootstrap-grid.css create mode 100644 docs/assets/vendor/bootstrap/css/bootstrap-grid.css.map create mode 100644 docs/assets/vendor/bootstrap/css/bootstrap-grid.min.css create mode 100644 docs/assets/vendor/bootstrap/css/bootstrap-grid.min.css.map create mode 100644 docs/assets/vendor/bootstrap/css/bootstrap-reboot.css create mode 100644 docs/assets/vendor/bootstrap/css/bootstrap-reboot.css.map create mode 100644 docs/assets/vendor/bootstrap/css/bootstrap-reboot.min.css create mode 100644 docs/assets/vendor/bootstrap/css/bootstrap-reboot.min.css.map create mode 100644 docs/assets/vendor/bootstrap/css/bootstrap.css create mode 100644 docs/assets/vendor/bootstrap/css/bootstrap.css.map create mode 100644 docs/assets/vendor/bootstrap/css/bootstrap.min.css create mode 100644 docs/assets/vendor/bootstrap/css/bootstrap.min.css.map create mode 100644 docs/assets/vendor/bootstrap/js/bootstrap.bundle.js create mode 100644 docs/assets/vendor/bootstrap/js/bootstrap.bundle.js.map create mode 100644 docs/assets/vendor/bootstrap/js/bootstrap.bundle.min.js create mode 100644 docs/assets/vendor/bootstrap/js/bootstrap.bundle.min.js.map create mode 100644 docs/assets/vendor/bootstrap/js/bootstrap.js create mode 100644 docs/assets/vendor/bootstrap/js/bootstrap.js.map create mode 100644 docs/assets/vendor/bootstrap/js/bootstrap.min.js create mode 100644 docs/assets/vendor/bootstrap/js/bootstrap.min.js.map create mode 100644 docs/assets/vendor/font-awesome/css/all.css create mode 100644 docs/assets/vendor/font-awesome/css/all.min.css create mode 100644 docs/assets/vendor/font-awesome/css/brands.css create mode 100644 docs/assets/vendor/font-awesome/css/brands.min.css create mode 100644 docs/assets/vendor/font-awesome/css/fontawesome.css create mode 100644 docs/assets/vendor/font-awesome/css/fontawesome.min.css create mode 100644 docs/assets/vendor/font-awesome/css/regular.css create mode 100644 docs/assets/vendor/font-awesome/css/regular.min.css create mode 100644 docs/assets/vendor/font-awesome/css/solid.css create mode 100644 docs/assets/vendor/font-awesome/css/solid.min.css create mode 100644 docs/assets/vendor/font-awesome/css/svg-with-js.css create mode 100644 docs/assets/vendor/font-awesome/css/svg-with-js.min.css create mode 100644 docs/assets/vendor/font-awesome/css/v4-shims.css create mode 100644 docs/assets/vendor/font-awesome/css/v4-shims.min.css create mode 100644 docs/assets/vendor/font-awesome/js/all.js create mode 100644 docs/assets/vendor/font-awesome/js/all.min.js create mode 100644 docs/assets/vendor/font-awesome/js/brands.js create mode 100644 docs/assets/vendor/font-awesome/js/brands.min.js create mode 100644 docs/assets/vendor/font-awesome/js/conflict-detection.js create mode 100644 docs/assets/vendor/font-awesome/js/conflict-detection.min.js create mode 100644 docs/assets/vendor/font-awesome/js/fontawesome.js create mode 100644 docs/assets/vendor/font-awesome/js/fontawesome.min.js create mode 100644 docs/assets/vendor/font-awesome/js/regular.js create mode 100644 docs/assets/vendor/font-awesome/js/regular.min.js create mode 100644 docs/assets/vendor/font-awesome/js/solid.js create mode 100644 docs/assets/vendor/font-awesome/js/solid.min.js create mode 100644 docs/assets/vendor/font-awesome/js/v4-shims.js create mode 100644 docs/assets/vendor/font-awesome/js/v4-shims.min.js create mode 100644 docs/assets/vendor/font-awesome/webfonts/fa-brands-400.eot create mode 100644 docs/assets/vendor/font-awesome/webfonts/fa-brands-400.svg create mode 100644 docs/assets/vendor/font-awesome/webfonts/fa-brands-400.ttf create mode 100644 docs/assets/vendor/font-awesome/webfonts/fa-brands-400.woff create mode 100644 docs/assets/vendor/font-awesome/webfonts/fa-brands-400.woff2 create mode 100644 docs/assets/vendor/font-awesome/webfonts/fa-regular-400.eot create mode 100644 docs/assets/vendor/font-awesome/webfonts/fa-regular-400.svg create mode 100644 docs/assets/vendor/font-awesome/webfonts/fa-regular-400.ttf create mode 100644 docs/assets/vendor/font-awesome/webfonts/fa-regular-400.woff create mode 100644 docs/assets/vendor/font-awesome/webfonts/fa-regular-400.woff2 create mode 100644 docs/assets/vendor/font-awesome/webfonts/fa-solid-900.eot create mode 100644 docs/assets/vendor/font-awesome/webfonts/fa-solid-900.svg create mode 100644 docs/assets/vendor/font-awesome/webfonts/fa-solid-900.ttf create mode 100644 docs/assets/vendor/font-awesome/webfonts/fa-solid-900.woff create mode 100644 docs/assets/vendor/font-awesome/webfonts/fa-solid-900.woff2 create mode 100644 docs/assets/vendor/highlight.js/highlight.js create mode 100644 docs/assets/vendor/highlight.js/highlight.min.js create mode 100644 docs/assets/vendor/highlight.js/languages/1c.js create mode 100644 docs/assets/vendor/highlight.js/languages/abnf.js create mode 100644 docs/assets/vendor/highlight.js/languages/accesslog.js create mode 100644 docs/assets/vendor/highlight.js/languages/actionscript.js create mode 100644 docs/assets/vendor/highlight.js/languages/ada.js create mode 100644 docs/assets/vendor/highlight.js/languages/angelscript.js create mode 100644 docs/assets/vendor/highlight.js/languages/apache.js create mode 100644 docs/assets/vendor/highlight.js/languages/applescript.js create mode 100644 docs/assets/vendor/highlight.js/languages/arcade.js create mode 100644 docs/assets/vendor/highlight.js/languages/arduino.js create mode 100644 docs/assets/vendor/highlight.js/languages/armasm.js create mode 100644 docs/assets/vendor/highlight.js/languages/asciidoc.js create mode 100644 docs/assets/vendor/highlight.js/languages/aspectj.js create mode 100644 docs/assets/vendor/highlight.js/languages/autohotkey.js create mode 100644 docs/assets/vendor/highlight.js/languages/autoit.js create mode 100644 docs/assets/vendor/highlight.js/languages/avrasm.js create mode 100644 docs/assets/vendor/highlight.js/languages/awk.js create mode 100644 docs/assets/vendor/highlight.js/languages/axapta.js create mode 100644 docs/assets/vendor/highlight.js/languages/bash.js create mode 100644 docs/assets/vendor/highlight.js/languages/basic.js create mode 100644 docs/assets/vendor/highlight.js/languages/bnf.js create mode 100644 docs/assets/vendor/highlight.js/languages/brainfuck.js create mode 100644 docs/assets/vendor/highlight.js/languages/c-like.js create mode 100644 docs/assets/vendor/highlight.js/languages/c.js create mode 100644 docs/assets/vendor/highlight.js/languages/cal.js create mode 100644 docs/assets/vendor/highlight.js/languages/capnproto.js create mode 100644 docs/assets/vendor/highlight.js/languages/ceylon.js create mode 100644 docs/assets/vendor/highlight.js/languages/clean.js create mode 100644 docs/assets/vendor/highlight.js/languages/clojure-repl.js create mode 100644 docs/assets/vendor/highlight.js/languages/clojure.js create mode 100644 docs/assets/vendor/highlight.js/languages/cmake.js create mode 100644 docs/assets/vendor/highlight.js/languages/coffeescript.js create mode 100644 docs/assets/vendor/highlight.js/languages/coq.js create mode 100644 docs/assets/vendor/highlight.js/languages/cos.js create mode 100644 docs/assets/vendor/highlight.js/languages/cpp.js create mode 100644 docs/assets/vendor/highlight.js/languages/crmsh.js create mode 100644 docs/assets/vendor/highlight.js/languages/crystal.js create mode 100644 docs/assets/vendor/highlight.js/languages/csharp.js create mode 100644 docs/assets/vendor/highlight.js/languages/csp.js create mode 100644 docs/assets/vendor/highlight.js/languages/css.js create mode 100644 docs/assets/vendor/highlight.js/languages/d.js create mode 100644 docs/assets/vendor/highlight.js/languages/dart.js create mode 100644 docs/assets/vendor/highlight.js/languages/delphi.js create mode 100644 docs/assets/vendor/highlight.js/languages/diff.js create mode 100644 docs/assets/vendor/highlight.js/languages/django.js create mode 100644 docs/assets/vendor/highlight.js/languages/dns.js create mode 100644 docs/assets/vendor/highlight.js/languages/dockerfile.js create mode 100644 docs/assets/vendor/highlight.js/languages/dos.js create mode 100644 docs/assets/vendor/highlight.js/languages/dsconfig.js create mode 100644 docs/assets/vendor/highlight.js/languages/dts.js create mode 100644 docs/assets/vendor/highlight.js/languages/dust.js create mode 100644 docs/assets/vendor/highlight.js/languages/ebnf.js create mode 100644 docs/assets/vendor/highlight.js/languages/elixir.js create mode 100644 docs/assets/vendor/highlight.js/languages/elm.js create mode 100644 docs/assets/vendor/highlight.js/languages/erb.js create mode 100644 docs/assets/vendor/highlight.js/languages/erlang-repl.js create mode 100644 docs/assets/vendor/highlight.js/languages/erlang.js create mode 100644 docs/assets/vendor/highlight.js/languages/excel.js create mode 100644 docs/assets/vendor/highlight.js/languages/fix.js create mode 100644 docs/assets/vendor/highlight.js/languages/flix.js create mode 100644 docs/assets/vendor/highlight.js/languages/fortran.js create mode 100644 docs/assets/vendor/highlight.js/languages/fsharp.js create mode 100644 docs/assets/vendor/highlight.js/languages/gams.js create mode 100644 docs/assets/vendor/highlight.js/languages/gauss.js create mode 100644 docs/assets/vendor/highlight.js/languages/gcode.js create mode 100644 docs/assets/vendor/highlight.js/languages/gherkin.js create mode 100644 docs/assets/vendor/highlight.js/languages/glsl.js create mode 100644 docs/assets/vendor/highlight.js/languages/gml.js create mode 100644 docs/assets/vendor/highlight.js/languages/go.js create mode 100644 docs/assets/vendor/highlight.js/languages/golo.js create mode 100644 docs/assets/vendor/highlight.js/languages/gradle.js create mode 100644 docs/assets/vendor/highlight.js/languages/groovy.js create mode 100644 docs/assets/vendor/highlight.js/languages/haml.js create mode 100644 docs/assets/vendor/highlight.js/languages/handlebars.js create mode 100644 docs/assets/vendor/highlight.js/languages/haskell.js create mode 100644 docs/assets/vendor/highlight.js/languages/haxe.js create mode 100644 docs/assets/vendor/highlight.js/languages/hsp.js create mode 100644 docs/assets/vendor/highlight.js/languages/htmlbars.js create mode 100644 docs/assets/vendor/highlight.js/languages/http.js create mode 100644 docs/assets/vendor/highlight.js/languages/hy.js create mode 100644 docs/assets/vendor/highlight.js/languages/inform7.js create mode 100644 docs/assets/vendor/highlight.js/languages/ini.js create mode 100644 docs/assets/vendor/highlight.js/languages/irpf90.js create mode 100644 docs/assets/vendor/highlight.js/languages/isbl.js create mode 100644 docs/assets/vendor/highlight.js/languages/java.js create mode 100644 docs/assets/vendor/highlight.js/languages/javascript.js create mode 100644 docs/assets/vendor/highlight.js/languages/jboss-cli.js create mode 100644 docs/assets/vendor/highlight.js/languages/json.js create mode 100644 docs/assets/vendor/highlight.js/languages/julia-repl.js create mode 100644 docs/assets/vendor/highlight.js/languages/julia.js create mode 100644 docs/assets/vendor/highlight.js/languages/kotlin.js create mode 100644 docs/assets/vendor/highlight.js/languages/lasso.js create mode 100644 docs/assets/vendor/highlight.js/languages/latex.js create mode 100644 docs/assets/vendor/highlight.js/languages/ldif.js create mode 100644 docs/assets/vendor/highlight.js/languages/leaf.js create mode 100644 docs/assets/vendor/highlight.js/languages/less.js create mode 100644 docs/assets/vendor/highlight.js/languages/lib/ecmascript.js create mode 100644 docs/assets/vendor/highlight.js/languages/lisp.js create mode 100644 docs/assets/vendor/highlight.js/languages/livecodeserver.js create mode 100644 docs/assets/vendor/highlight.js/languages/livescript.js create mode 100644 docs/assets/vendor/highlight.js/languages/llvm.js create mode 100644 docs/assets/vendor/highlight.js/languages/lsl.js create mode 100644 docs/assets/vendor/highlight.js/languages/lua.js create mode 100644 docs/assets/vendor/highlight.js/languages/makefile.js create mode 100644 docs/assets/vendor/highlight.js/languages/markdown.js create mode 100644 docs/assets/vendor/highlight.js/languages/mathematica.js create mode 100644 docs/assets/vendor/highlight.js/languages/matlab.js create mode 100644 docs/assets/vendor/highlight.js/languages/maxima.js create mode 100644 docs/assets/vendor/highlight.js/languages/mel.js create mode 100644 docs/assets/vendor/highlight.js/languages/mercury.js create mode 100644 docs/assets/vendor/highlight.js/languages/mipsasm.js create mode 100644 docs/assets/vendor/highlight.js/languages/mizar.js create mode 100644 docs/assets/vendor/highlight.js/languages/mojolicious.js create mode 100644 docs/assets/vendor/highlight.js/languages/monkey.js create mode 100644 docs/assets/vendor/highlight.js/languages/moonscript.js create mode 100644 docs/assets/vendor/highlight.js/languages/n1ql.js create mode 100644 docs/assets/vendor/highlight.js/languages/nginx.js create mode 100644 docs/assets/vendor/highlight.js/languages/nim.js create mode 100644 docs/assets/vendor/highlight.js/languages/nix.js create mode 100644 docs/assets/vendor/highlight.js/languages/nsis.js create mode 100644 docs/assets/vendor/highlight.js/languages/objectivec.js create mode 100644 docs/assets/vendor/highlight.js/languages/ocaml.js create mode 100644 docs/assets/vendor/highlight.js/languages/openscad.js create mode 100644 docs/assets/vendor/highlight.js/languages/oxygene.js create mode 100644 docs/assets/vendor/highlight.js/languages/parser3.js create mode 100644 docs/assets/vendor/highlight.js/languages/perl.js create mode 100644 docs/assets/vendor/highlight.js/languages/pf.js create mode 100644 docs/assets/vendor/highlight.js/languages/pgsql.js create mode 100644 docs/assets/vendor/highlight.js/languages/php-template.js create mode 100644 docs/assets/vendor/highlight.js/languages/php.js create mode 100644 docs/assets/vendor/highlight.js/languages/plaintext.js create mode 100644 docs/assets/vendor/highlight.js/languages/pony.js create mode 100644 docs/assets/vendor/highlight.js/languages/powershell.js create mode 100644 docs/assets/vendor/highlight.js/languages/processing.js create mode 100644 docs/assets/vendor/highlight.js/languages/profile.js create mode 100644 docs/assets/vendor/highlight.js/languages/prolog.js create mode 100644 docs/assets/vendor/highlight.js/languages/properties.js create mode 100644 docs/assets/vendor/highlight.js/languages/protobuf.js create mode 100644 docs/assets/vendor/highlight.js/languages/puppet.js create mode 100644 docs/assets/vendor/highlight.js/languages/purebasic.js create mode 100644 docs/assets/vendor/highlight.js/languages/python-repl.js create mode 100644 docs/assets/vendor/highlight.js/languages/python.js create mode 100644 docs/assets/vendor/highlight.js/languages/q.js create mode 100644 docs/assets/vendor/highlight.js/languages/qml.js create mode 100644 docs/assets/vendor/highlight.js/languages/r.js create mode 100644 docs/assets/vendor/highlight.js/languages/reasonml.js create mode 100644 docs/assets/vendor/highlight.js/languages/rib.js create mode 100644 docs/assets/vendor/highlight.js/languages/roboconf.js create mode 100644 docs/assets/vendor/highlight.js/languages/routeros.js create mode 100644 docs/assets/vendor/highlight.js/languages/rsl.js create mode 100644 docs/assets/vendor/highlight.js/languages/ruby.js create mode 100644 docs/assets/vendor/highlight.js/languages/ruleslanguage.js create mode 100644 docs/assets/vendor/highlight.js/languages/rust.js create mode 100644 docs/assets/vendor/highlight.js/languages/sas.js create mode 100644 docs/assets/vendor/highlight.js/languages/scala.js create mode 100644 docs/assets/vendor/highlight.js/languages/scheme.js create mode 100644 docs/assets/vendor/highlight.js/languages/scilab.js create mode 100644 docs/assets/vendor/highlight.js/languages/scss.js create mode 100644 docs/assets/vendor/highlight.js/languages/shell.js create mode 100644 docs/assets/vendor/highlight.js/languages/smali.js create mode 100644 docs/assets/vendor/highlight.js/languages/smalltalk.js create mode 100644 docs/assets/vendor/highlight.js/languages/sml.js create mode 100644 docs/assets/vendor/highlight.js/languages/sqf.js create mode 100644 docs/assets/vendor/highlight.js/languages/sql.js create mode 100644 docs/assets/vendor/highlight.js/languages/stan.js create mode 100644 docs/assets/vendor/highlight.js/languages/stata.js create mode 100644 docs/assets/vendor/highlight.js/languages/step21.js create mode 100644 docs/assets/vendor/highlight.js/languages/stylus.js create mode 100644 docs/assets/vendor/highlight.js/languages/subunit.js create mode 100644 docs/assets/vendor/highlight.js/languages/swift.js create mode 100644 docs/assets/vendor/highlight.js/languages/taggerscript.js create mode 100644 docs/assets/vendor/highlight.js/languages/tap.js create mode 100644 docs/assets/vendor/highlight.js/languages/tcl.js create mode 100644 docs/assets/vendor/highlight.js/languages/thrift.js create mode 100644 docs/assets/vendor/highlight.js/languages/tp.js create mode 100644 docs/assets/vendor/highlight.js/languages/twig.js create mode 100644 docs/assets/vendor/highlight.js/languages/typescript.js create mode 100644 docs/assets/vendor/highlight.js/languages/vala.js create mode 100644 docs/assets/vendor/highlight.js/languages/vbnet.js create mode 100644 docs/assets/vendor/highlight.js/languages/vbscript-html.js create mode 100644 docs/assets/vendor/highlight.js/languages/vbscript.js create mode 100644 docs/assets/vendor/highlight.js/languages/verilog.js create mode 100644 docs/assets/vendor/highlight.js/languages/vhdl.js create mode 100644 docs/assets/vendor/highlight.js/languages/vim.js create mode 100644 docs/assets/vendor/highlight.js/languages/x86asm.js create mode 100644 docs/assets/vendor/highlight.js/languages/xl.js create mode 100644 docs/assets/vendor/highlight.js/languages/xml.js create mode 100644 docs/assets/vendor/highlight.js/languages/xquery.js create mode 100644 docs/assets/vendor/highlight.js/languages/yaml.js create mode 100644 docs/assets/vendor/highlight.js/languages/zephir.js create mode 100644 docs/assets/vendor/highlight.js/lib/html_renderer.js create mode 100644 docs/assets/vendor/highlight.js/lib/mode_compiler.js create mode 100644 docs/assets/vendor/highlight.js/lib/modes.js create mode 100644 docs/assets/vendor/highlight.js/lib/regex.js create mode 100644 docs/assets/vendor/highlight.js/lib/response.js create mode 100644 docs/assets/vendor/highlight.js/lib/token_tree.js create mode 100644 docs/assets/vendor/highlight.js/lib/utils.js create mode 100644 docs/assets/vendor/highlight.js/styles/a11y-dark.css create mode 100644 docs/assets/vendor/highlight.js/styles/a11y-light.css create mode 100644 docs/assets/vendor/highlight.js/styles/agate.css create mode 100644 docs/assets/vendor/highlight.js/styles/an-old-hope.css create mode 100644 docs/assets/vendor/highlight.js/styles/androidstudio.css create mode 100644 docs/assets/vendor/highlight.js/styles/arduino-light.css create mode 100644 docs/assets/vendor/highlight.js/styles/arta.css create mode 100644 docs/assets/vendor/highlight.js/styles/ascetic.css create mode 100644 docs/assets/vendor/highlight.js/styles/atelier-cave-dark.css create mode 100644 docs/assets/vendor/highlight.js/styles/atelier-cave-light.css create mode 100644 docs/assets/vendor/highlight.js/styles/atelier-dune-dark.css create mode 100644 docs/assets/vendor/highlight.js/styles/atelier-dune-light.css create mode 100644 docs/assets/vendor/highlight.js/styles/atelier-estuary-dark.css create mode 100644 docs/assets/vendor/highlight.js/styles/atelier-estuary-light.css create mode 100644 docs/assets/vendor/highlight.js/styles/atelier-forest-dark.css create mode 100644 docs/assets/vendor/highlight.js/styles/atelier-forest-light.css create mode 100644 docs/assets/vendor/highlight.js/styles/atelier-heath-dark.css create mode 100644 docs/assets/vendor/highlight.js/styles/atelier-heath-light.css create mode 100644 docs/assets/vendor/highlight.js/styles/atelier-lakeside-dark.css create mode 100644 docs/assets/vendor/highlight.js/styles/atelier-lakeside-light.css create mode 100644 docs/assets/vendor/highlight.js/styles/atelier-plateau-dark.css create mode 100644 docs/assets/vendor/highlight.js/styles/atelier-plateau-light.css create mode 100644 docs/assets/vendor/highlight.js/styles/atelier-savanna-dark.css create mode 100644 docs/assets/vendor/highlight.js/styles/atelier-savanna-light.css create mode 100644 docs/assets/vendor/highlight.js/styles/atelier-seaside-dark.css create mode 100644 docs/assets/vendor/highlight.js/styles/atelier-seaside-light.css create mode 100644 docs/assets/vendor/highlight.js/styles/atelier-sulphurpool-dark.css create mode 100644 docs/assets/vendor/highlight.js/styles/atelier-sulphurpool-light.css create mode 100644 docs/assets/vendor/highlight.js/styles/atom-one-dark-reasonable.css create mode 100644 docs/assets/vendor/highlight.js/styles/atom-one-dark.css create mode 100644 docs/assets/vendor/highlight.js/styles/atom-one-light.css create mode 100644 docs/assets/vendor/highlight.js/styles/brown-paper.css create mode 100644 docs/assets/vendor/highlight.js/styles/brown-papersq.png create mode 100644 docs/assets/vendor/highlight.js/styles/codepen-embed.css create mode 100644 docs/assets/vendor/highlight.js/styles/color-brewer.css create mode 100644 docs/assets/vendor/highlight.js/styles/darcula.css create mode 100644 docs/assets/vendor/highlight.js/styles/dark.css create mode 100644 docs/assets/vendor/highlight.js/styles/default.css create mode 100644 docs/assets/vendor/highlight.js/styles/docco.css create mode 100644 docs/assets/vendor/highlight.js/styles/dracula.css create mode 100644 docs/assets/vendor/highlight.js/styles/far.css create mode 100644 docs/assets/vendor/highlight.js/styles/foundation.css create mode 100644 docs/assets/vendor/highlight.js/styles/github-gist.css create mode 100644 docs/assets/vendor/highlight.js/styles/github.css create mode 100644 docs/assets/vendor/highlight.js/styles/gml.css create mode 100644 docs/assets/vendor/highlight.js/styles/googlecode.css create mode 100644 docs/assets/vendor/highlight.js/styles/gradient-dark.css create mode 100644 docs/assets/vendor/highlight.js/styles/grayscale.css create mode 100644 docs/assets/vendor/highlight.js/styles/gruvbox-dark.css create mode 100644 docs/assets/vendor/highlight.js/styles/gruvbox-light.css create mode 100644 docs/assets/vendor/highlight.js/styles/hopscotch.css create mode 100644 docs/assets/vendor/highlight.js/styles/hybrid.css create mode 100644 docs/assets/vendor/highlight.js/styles/idea.css create mode 100644 docs/assets/vendor/highlight.js/styles/ir-black.css create mode 100644 docs/assets/vendor/highlight.js/styles/isbl-editor-dark.css create mode 100644 docs/assets/vendor/highlight.js/styles/isbl-editor-light.css create mode 100644 docs/assets/vendor/highlight.js/styles/kimbie.dark.css create mode 100644 docs/assets/vendor/highlight.js/styles/kimbie.light.css create mode 100644 docs/assets/vendor/highlight.js/styles/lightfair.css create mode 100644 docs/assets/vendor/highlight.js/styles/magula.css create mode 100644 docs/assets/vendor/highlight.js/styles/mono-blue.css create mode 100644 docs/assets/vendor/highlight.js/styles/monokai-sublime.css create mode 100644 docs/assets/vendor/highlight.js/styles/monokai.css create mode 100644 docs/assets/vendor/highlight.js/styles/night-owl.css create mode 100644 docs/assets/vendor/highlight.js/styles/nord.css create mode 100644 docs/assets/vendor/highlight.js/styles/obsidian.css create mode 100644 docs/assets/vendor/highlight.js/styles/ocean.css create mode 100644 docs/assets/vendor/highlight.js/styles/paraiso-dark.css create mode 100644 docs/assets/vendor/highlight.js/styles/paraiso-light.css create mode 100644 docs/assets/vendor/highlight.js/styles/pojoaque.css create mode 100644 docs/assets/vendor/highlight.js/styles/pojoaque.jpg create mode 100644 docs/assets/vendor/highlight.js/styles/purebasic.css create mode 100644 docs/assets/vendor/highlight.js/styles/qtcreator_dark.css create mode 100644 docs/assets/vendor/highlight.js/styles/qtcreator_light.css create mode 100644 docs/assets/vendor/highlight.js/styles/railscasts.css create mode 100644 docs/assets/vendor/highlight.js/styles/rainbow.css create mode 100644 docs/assets/vendor/highlight.js/styles/routeros.css create mode 100644 docs/assets/vendor/highlight.js/styles/school-book.css create mode 100644 docs/assets/vendor/highlight.js/styles/school-book.png create mode 100644 docs/assets/vendor/highlight.js/styles/shades-of-purple.css create mode 100644 docs/assets/vendor/highlight.js/styles/solarized-dark.css create mode 100644 docs/assets/vendor/highlight.js/styles/solarized-light.css create mode 100644 docs/assets/vendor/highlight.js/styles/srcery.css create mode 100644 docs/assets/vendor/highlight.js/styles/sunburst.css create mode 100644 docs/assets/vendor/highlight.js/styles/tomorrow-night-blue.css create mode 100644 docs/assets/vendor/highlight.js/styles/tomorrow-night-bright.css create mode 100644 docs/assets/vendor/highlight.js/styles/tomorrow-night-eighties.css create mode 100644 docs/assets/vendor/highlight.js/styles/tomorrow-night.css create mode 100644 docs/assets/vendor/highlight.js/styles/tomorrow.css create mode 100644 docs/assets/vendor/highlight.js/styles/vs.css create mode 100644 docs/assets/vendor/highlight.js/styles/vs2015.css create mode 100644 docs/assets/vendor/highlight.js/styles/xcode.css create mode 100644 docs/assets/vendor/highlight.js/styles/xt256.css create mode 100644 docs/assets/vendor/highlight.js/styles/zenburn.css create mode 100644 docs/assets/vendor/highlight.js/vendor/deep_freeze.js create mode 100644 docs/assets/vendor/jquery.easing/jquery.easing.js create mode 100644 docs/assets/vendor/jquery.easing/jquery.easing.min.js create mode 100644 docs/assets/vendor/jquery/jquery.min.js create mode 100644 docs/assets/vendor/magnific-popup/jquery.magnific-popup.js create mode 100644 docs/assets/vendor/magnific-popup/jquery.magnific-popup.min.js create mode 100644 docs/assets/vendor/magnific-popup/magnific-popup.css create mode 100644 docs/assets/vendor/magnific-popup/magnific-popup.min.css create mode 100644 docs/index.html delete mode 100644 docs/index.md diff --git a/ByBit.Net/Icon/icon.png b/ByBit.Net/Icon/icon.png index b293d71356f836336ce8049bc983c9284d6e3f02..225c6449f319e8617e1687df03335c47fc855909 100644 GIT binary patch delta 4649 zcmV+^64vd6A=4y~ReuraNkl^R7>j4P0;lrcEQU<|?tbRc99I??JDtCh4f ztG%z8o!vR!>wN$J-ptO9c6Oc)S7pne=zZP&y8HG2_5c6<_kVkX(puB+Gg1WH5mv75 zXtArzZ|HL)ZujD8gXZbJB3FYaY#tac@zfS3jOLKvQ(NAbIM*@7yPz}_KNKv?tC$*z zwVccIbu1eS$v~3~Lco+WR}~sseMc!>u1z(f+1I?9DZ?x?qkm>d$8=F~o^fB#%FqdW+(`o=U|Q?U^}SKwizs`!4vE!b>{Tll8K$PV zNfbAbw4#`l6(x+mx~ljmK3*7^bOgBgkKbkXONk&PDF~c))gVBlodLlU5H@ZgiSQsn z%7nbHzekr?V@xgx0Z~&GODPk){+zJT5S|6K5^F(%wSRyU^3aSt)}2WRA;3qPHGoCE z5M0Yb#%y8ZsNj5(j0DP>JR?ymusTdG2muLFem3+mV8Klmn1wZ9>u?rvwt3FmzQB+z z1ol8iNwF~^{U#a23D%vT)_8iTU^j~SQp<9&+Q-ePN*HhInCVpsJ*ZDcz)fMr-rGHIKC@DNUx`f$At9vg=1LiMS!TZ8G zQ@J0&j`{_+a=Bc*yXJu6-Ip}>TJt4jUO@iM!%gqU<>p1gF#!#orSqD53-{@SE)vyG zdU->)(ye{fc3Vf7zwmk=E?UD2x$u}0+9HcFgobY!K>`H6JlP&3Pos zq{MPD1r9YKtuIGo)QyVIV^ww>X?j1mWPlR_WF}KQi9QHy*p4sh0QrhPxzSL6o!=z& zV^f>k(UXPeCv#%KEh+$>kO4bGJG&-3(0?}B7vu1N3O%u)JC;bs8-jts1NpR!)e>As;Aks(%S~ zPKdAyN;QJx7LZUW<;#E&&>Qv^TPr?Bczzr^v~f|_u%Z?-`G~Zu%pN8M1W2q2a?OT| zGzU9pX#*EgSBl|}ENQ&yqMURlWaiNG0SF$zq2?^MzB3s9G*UBs)=6oVfx5ZN3nBQc zut!@B#}O2>WKEFSPJoLcA&m$I7k_Yw)4yqKTxCVDmjEH4vquFBlwMWjrKN>_wY12m zmKA!{H3fNUt+dL3LF(TP(v7yK2eOzuuN00BSBeBihBlz27Qg{-u&OQ|vJFmzFg-;Q0Nd zQw>;zB#u6gXtBL>h+5mj6zB>eg=ru>0$%JD!liFugaREQipJt8k`jhN-F*?~*kGfbK z1fe4$@qGBI8)YB|aO4E5YOeVja^H_93_W9dv8t=9BCpT-hQj~)`UdE&-y9-8BB|<% z5?ZpPo;)5mH8-E7^XVH>Xc}@Codj7fp(cy4J@7Z@yy9*cS9q+z}Hp6;o2xCO}8qw!k1Nw&> zpVf2gm!r>ez2Q$6=-7)s{qA@CnyOam?b~X%-68GYvI zg-cfJMN3v~=XsAOPiAst0$_X%noHj2_fknoF}bm-9e?ee)Y{5N2$Qb6ZaIDPum1|V zeu}ofvkd`_i&oxnJ>7Np15`fkYP#vBRa97*PrG)$N5;@`_bb#!!7FmN7P*hhs^ zz2rg{rGJ%U6L9JSX4qGdVUow~pqrIC>s)z#P1np;0jn||~Q z+P!Bl&73)d*5CChdg5=sLN#-$>FCkp^wSr9DdQwJwwHhTD_Ssr9#vP}KzsKcpyHwe zDHHi2GjHc;>B5<3I7W|r?ORlfaenZFjRXy&u79p>dgRf^skU|w{nNi}q?(E{`AC5t z9vR#L91)Q?IDSqsQYkYt~it^>6$IZQAso^w2{O zit~BxSHGqM`*xFmNs;v2Mg&mO4tESghWLrsSc(=Yz_b&SBDAzfmBj6b-2E&b%# zXXxAC{#%+4Z93G{M6bNM8F##R77J%f1%DdYu`>9)!1LfgZa3;&eq6_hlI)ZdPEDXQ zeMmmlMPo78Ups6vK%E_(tQWLs(E=*Js-DWrywrMTFTK5GD}`X=2_r$B=&-=e`#m{zU6k^bKG(y?yaO?KjNA( zUoWlvC@0nd%Fu@Jf%IFeJ~tc@pntTv-+sJhT=s(#9Ipb?v1)ENR2F7n*{2oIxS*aK z5pvv^R8i}+FuGbv8KzG!ro4PBfODa3ewl|}-cvx|_~}&Iu%&=%i`e&At$9SNqqUV; zz{tp(AOYj=x9W1kApwaUh+8Gkwr;|qRaaNT+y4i3c6QT0{QZ+~V1;zz_C5^u5U<$GS+8S^V9ArmlC%w7(Wm>)J1_}>_u^a5C;l5t#8u8OBr@VBa z-Aka7OoYu0HbJ(17sj{(OgQza+bZbq_QQg9XPX z;P`#OtjfmMm8MU*JudC{dr{4v+*;+{{s?uqH<8C%PqSxFv8Q6)^MAo4IEX?RE#{CM z&x?@QEnzD^12zodP98fi_vSRrBoA&_QyV)!uJd?Y*#0;a$GA8@SO#YS=CS4E(cO1& zzQu>8s50;v(?#*xp$mm|Oh83N<7YAYs|grdG;X5W+KRZh8-nKfulRcyI3{3r9LT#T5tAT`ena6Jc2V}OR@3X()j0Jd>yG5)+$V4sA* zz%Eh5Wm4IR;~&UJ)LgPL9Qgo7Ti`H4GxHI7^_H*^?(p0n#5!?6h@QBk?%W^kQ)|IWR+4cm7%BuBWwBv2GH5`)hUc9ML$ zv_{G{Uwv!yseiqxfQ|9CpS}+3;FDnioN5gDBKU+jMhTZHdZ<3ELl>n1j9}pKyO_@= zyJ$^`S875{NdCzH>UejRMVMeA_)B?~(UYBik|{jHP_!cMqPwvJ+=={W;4E*&j&KLK zT;_w{<~A2i00Xx67z96L7sdCp4Ql>5K^8%{(YUJ2vVZdnQt3B-Uk1N%=5Gd;PY`fp zE*wSnQK`uQRy>NmN#Qy+VJG$416>jUf#Bf?=E83+IOtE!NT$SsWFtXRmV4Q|r68Kd z8Y4rAZH7V3I;{S}roaZDrLO?b16kD{pWJO7F|z=^)qv1?jPQKLaRz6rA!);ZE(gKD z(SAJRTFmOd?J7J%0RNVQ1iqJfU+VaCIViI3jelu?!Jo&zacxWU9{U&W*#V(lEI13z zf^wcCLnIGQCODW}0Rk9-;E|}J#6uv0V{j{=w~2sCvm{cH32}^^GPHqvu=Gp-lC(fN z4~@P9NArhIH}8pBEhh$VdC8S$El85Unvt(a{tuTcLI5KeIIgipZh`*RV!nTdtz2%Zol-!pg8Kt!a-VD1yZ;xi>p?>8+2;Kl z&U}2((W<8d!bKsl{Mvv87hk~jxaMo><9{|69SL3vDk~Qk;wiN-$rak=T8u&YomU+a z+abRK=HDc3!}X|3tG$?2OY7N>#7SKa4j0pRG5yEvRZr~%Af`9ZptaNb^}(D3{C~q% zzgmju?kNalVkL_q6pB;?!Pwq$pcWy0sOMAq9OP%DYXJUZ0=i1$)L1a6J0>3i1%K+g z1krW~RFD)5NvGvG$$J3F+gBEzRi6P{>-8ISJ2c?H754$ZYj`x3La5aCmJ~RZAm0VT zopA$m240&$WPUm*m%_lg8T{fu=!7>_<5gbCKJxDTXt$mq|bn5)XkKT=@q{93mYiR7i^n fOiBW-9Eko8q}~5bnPzN_00000NkvXXu0mjfz6 zGI`ogIwW+MX-R226bOYv#)%)HkcXiq38^1o8isZ#Wta>m#hoUQ!QeVh3?+e(5Xa8T zII<(hjx5Wv-qK3@x~Jd&pL=%iN-JsCc9?4V*=Nsx&OML+`+v`W{(J7dQd(>J|BQ?Q z)($G?Ts-R3gwy)uNFZ=oZNK|=PldB6IOx7ITos&Go=P7d2nXlY^`uUARF*VV4eRMk)Kw6oeQc zM4CN-sg4ELGRcHTHi-(Btuaz4YYL9UDPlTIErbHK!1Cd_2h*y{)uN#64; zd$Axbw-D?HN>@eGBhqh*L4x3d_S&Uy4@G{9Vwu!3FLwK+8&|3HUY&4DR7&^jM7mU^ z++LJ9AAi)Y4kJ?FELbsqe>&{wMQ*|! zNnX{3iVMSIyPo*@lTSQx^U;>$1mmHGV=YHnc0`xTO2a(;FTee*o%>d;TK2GXx&YWS z&O{IcG@hQ`{BEr5*AOE@UiP*a;3Ta)H`i->UVnJ-p`H4%T|Xp81-%+f$~PDvaL$0X zYz)_2W0~t!nm%;Px=%gw$d|t-6-A<81Jt+Gt?rD4_h}afu;e+=rQFl>!R}dJ+oEvo zjkoId(`O;69Ku%Sc^$_PW#l&kyhEDctWs0`%r6h@xrs}Kq7Vbf@X?ZFCjy!)Zg0uU z?SD=~C=Pdgdc9uMv=Zby*_{P`MXbyubLw%V;BCOfr5=W0xHxv8KwUk3H!f+uMsMBr z=z6(ukzhQawRUCaQ0Q44X(M6;A&-H*=j7x)Z$lNam(mOM{tCN}!{l^9Q< zY`ygg%+Io9rkowprJ=zDEm^iY|6oNz3=oT9@5`|kGbS)@#t3eyw3+}nthw!q1&gl~ zz4^zkrk`v+ne+T@*a#Q{0g%;`t-(WLOZa8d0a~*Bn(P4Q2{FL5(s&o#-Zif8k$>kC z9wh!54`2D}*64{7?Js%79E>LDM}Fd?WQhsJ0gcQsMu2w42#}X7zc5b_19T6TM9qrl zkjKn8B~O6I9^2i=jYgB;G};qvy+vWN{2JM=KGU}b5hDa>>9P-II~55r0Q|fU#NWk3 z%{#aYoWOK%BOM2ax1?1bELi*j=zq%d<`T6SkCe;DYY*eK$;!MPI5T}rOyK|Cc95;Y z@j=nLn?G_=8WjmKz}YU<7EyY2MF};RhgEY$NUbO@QOhEw>PBfb3OjauTU#C)TFIUj zdGb|e&zP(YBS!{VE!%+uqgcQrE|(!|YHL3?=LfrX&-ZEyhTH}xLiQGw#eby>R-lu; zHCZ?)XUFpQyJ)gKELoWW<4X&a`B44Fq31FkCga91qZNU5xBQu%854LeD&Q62f~gpH zHH(y8-&xFfg53__Da{OV)`gjW=ihhj=GsD0v#jU416& z$sB)}E|*z`VV?Z)o@H{e02Ji`jq{eFxuP4E;_MLYqBHSY`pr>$oo&f0U`ni&uWQaY zqh*H@bnE5a$TdCn+H}wiP0(I`jSNp{j1JQB*@KjJN@&j;wNN2Ib$_){`o)1glX7De zJ4mcG3y_8J8|3Y zk}}7E<&A^%@LvqmKYkQ?a5H#9XP0r*LQt>)cKydw`y|l#R>Q#D28|)C`6oP^c@cr+7e+}oNq_-CtMqe&l zf+m@IgR!Ix{4&EDH@8i8t|YcbNBVu#o^HmOE#GTswDpYe^S#eJ?Nv^Qf(>xA<=7a7 z1+1W(0{sLE{#8b=|Lpmam%XNl4USVIeL)J4AoLid7OgS!=OZ`2d2^5 z2YM;4s-)lQS#Q!0Hr3D&)zi{V0rWJ1k%=AKen!Sxu{lMkryFS9yjNvB(8s2zp)2mImbn{d)Y1NZ zPmbQNV^FXMm_4408D;07)S#?zP>;~u%658VXPQd%AliG4a*(?LXne6iYB> z2;*$My_X*S+j6Vcga*&YJm05&662 zdKLlN_?>pz@*`87R8d-WFTZ%@d5MOGV$y0d6l?%?T~;<@2xPtKOXy3Fhv0e*)H*z$ zR^8QxHGfhxEx-?E9K8G*`-%JOd0a2hVUBCQ*h8lhO%ziz=$>6=)T?KsTGL;xHn+zN zFj$)3<7obr!E5fo^i@*N^F+$cCyvQbxCih*nH0(My7rMd=1eYdutp2;%lCD-B9!3w zs|O1Fr@3c;;;MyIrA zy~U_11Q|gReXm*ABXyhtxbH8S*@JqAe)i&!=`#jdqxi+Xp053#I3Wr)KvUB~BVdvP zM}HzPKp6WyNpJnLqC3|N(%yflq_5l#MtB(c?!Gv8efrbp3sO=6{d^ z<@nZ_R%Nv0ZcVGc5Tjq6Sw>HvxSUpO7&5Bk$KGBwmC))h_R&pS64Wv<4`Vja?$?^= zvM*Fn+c07c=GO3lj(8oN9j=FId3=|K(-A3mj!Z{9@~l$?ih3Gsn7u@r^CvB9fAc(U z?5H6-p6u`EZ^Lq#?xG_*lgyef+kfa_t2B6R7#KtTFvWn!;W*2$0Q_UJA~~PdeAoDC z@cHNVUHqrP4eS4IkSF4St-k&Pl7eg}m8U<<9N48uCw**4Mw(en0m%t8`iJj{6ts<-wmshcgj?#wcKYRAByq-27h}2Ps;tq zTYPe(Paa!v-P=p zXxg~p^Z)4;=+d~>vysLl&wnV|0~j-AEoBePAm7R`a%K62#qngQN}#k^?d4>n=myRAg7*?+LtMxvGsvhU@LM z2kzZy+_MOrmj^IrHeROr+r7EYiBEaiwuQ+&wlX`Agbet%48oYQdXz%x%Z zdPTwhFl`Db`eTTZprQoi3dDpYdJR@9`ozLPJ#gLzVARiAB5THNcoZvJ6eeel;NJpS znUN*V`sM~-{?&B+t(UWddid{BdK{tWqx>d<6O4ePyZkxqi8`W{jRU&#ytaVFJsUn- z1q+H&JUi!pgZj&(>wk@#v&=oSvTbH$%ZbM^vKZSp7C&a?BhLWYIEX9cxe2x?F)EMR zXhmZ4<~#c@oj>y``A7q$?8^ET^dr{@S)Gk+12q%mhbwCo$pCX!un+?wZ++`vcA!xJ z(G&=0R^Fe=&HJ_sGXUc^&prLp*>_*ZkWdka7E5fR*Wk9CD}OU_?!#q%SmK<^T#rn^ z?X782)Y_7b`1t^$F1tRH%oxFx1B0*ux4B>gSe$8lT{)P*J{pg9RlhtM*=znj-V@^} zBftby9gR@yu~#M}&wxH@kk&cmId{mdP$bXS7tH{S_O>_FE$glm68w)bo)M%?-fPUu zdXFV;jKKKJr+@zXuEPg^WeSr3q#Y*Cq?stod@@7|#)xXT%>~^BCc;&#*65R`%(0i@ zA7?z7*H?K@lKiDfakvs_n%PkM>kl7D;2x6d=z@`N$|LtOcCGUW^a=A|GN zl$G@e3Q@1@KlE_oG8w}OJAkO4mthV=n;^joWL6<&R*Q?)|at2@= ztxr%3=PK$tLsUIYQ%}F5s)(k3Fb<;}OE?q=Yf20gm9P=YH6;gN9OV2xg-?emHNbyf gG6g;0;)3XZ0eQ`|GXgaGH2?qr07*qoM6N<$g1l!t^#A|> diff --git a/docs/ClientInfo/CopyTradingApi/IBybitRestClientCopyTradingApi.md b/docs/ClientInfo/CopyTradingApi/IBybitRestClientCopyTradingApi.md deleted file mode 100644 index a4dd8fa7..00000000 --- a/docs/ClientInfo/CopyTradingApi/IBybitRestClientCopyTradingApi.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: IBybitRestClientCopyTradingApi -has_children: true -parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > CopyTradingApi` -*Bybit Copy Trading endpoints* - -*** -*Endpoints related to account settings, info or actions* -**[IBybitRestClientCopyTradingApiAccount](IBybitRestClientCopyTradingApiAccount.html) Account { get; }** -*** -*Endpoints related to retrieving market and system data* -**[IBybitRestClientCopyTradingApiExchangeData](IBybitRestClientCopyTradingApiExchangeData.html) ExchangeData { get; }** -*** -*Endpoints related to orders and trades* -**[IBybitRestClientCopyTradingApiTrading](IBybitRestClientCopyTradingApiTrading.html) Trading { get; }** diff --git a/docs/ClientInfo/CopyTradingApi/IBybitRestClientCopyTradingApiAccount.md b/docs/ClientInfo/CopyTradingApi/IBybitRestClientCopyTradingApiAccount.md deleted file mode 100644 index c92cc769..00000000 --- a/docs/ClientInfo/CopyTradingApi/IBybitRestClientCopyTradingApiAccount.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: IBybitRestClientCopyTradingApiAccount -has_children: false -parent: IBybitRestClientCopyTradingApi -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > CopyTradingApi > Account` -*Bybit account endpoints. Account endpoints include balance info, withdraw/deposit info and requesting and account settings* - - -*** - -## GetBalancesAsync - -[https://bybit-exchange.github.io/docs/copy_trading/#t-ct_wallet_balance](https://bybit-exchange.github.io/docs/copy_trading/#t-ct_wallet_balance) -

- -*Get the current wallet balance* - -```csharp -var client = new BybitRestClient(); -var result = await client.CopyTradingApi.Account.GetBalancesAsync(); -``` - -```csharp -Task> GetBalancesAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## TransferAsync - -[https://bybit-exchange.github.io/docs/copy_trading/#t-ct_wallet_transfer](https://bybit-exchange.github.io/docs/copy_trading/#t-ct_wallet_transfer) -

- -*Transfer to or from the Copy Trading account* - -```csharp -var client = new BybitRestClient(); -var result = await client.CopyTradingApi.Account.TransferAsync(/* parameters */); -``` - -```csharp -Task> TransferAsync(string transferId, string asset, decimal quantity, AccountType fromAccount, AccountType toAccount, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|transferId|Uninque id| -|asset|Asset to transfer| -|quantity|Quantity to transfer| -|fromAccount|From account type| -|toAccount|To account type| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/CopyTradingApi/IBybitRestClientCopyTradingApiExchangeData.md b/docs/ClientInfo/CopyTradingApi/IBybitRestClientCopyTradingApiExchangeData.md deleted file mode 100644 index 6df8ffda..00000000 --- a/docs/ClientInfo/CopyTradingApi/IBybitRestClientCopyTradingApiExchangeData.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: IBybitRestClientCopyTradingApiExchangeData -has_children: false -parent: IBybitRestClientCopyTradingApi -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > CopyTradingApi > ExchangeData` -*Bybit Copy Trading exchange data endpoints. Exchange data includes market data (tickers, order books, etc) and system status.* - - -*** - -## GetServerTimeAsync - -[https://bybit-exchange.github.io/docs/copy_trading/#t-servertime](https://bybit-exchange.github.io/docs/copy_trading/#t-servertime) -

- -*Retrieve the server timestamp* - -```csharp -var client = new BybitRestClient(); -var result = await client.CopyTradingApi.ExchangeData.GetServerTimeAsync(); -``` - -```csharp -Task> GetServerTimeAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|| - -

- -*** - -## GetSymbolsAsync - -[https://bybit-exchange.github.io/docs/copy_trading/#t-ct_symbol_list](https://bybit-exchange.github.io/docs/copy_trading/#t-ct_symbol_list) -

- -*Get a list of supported symbols* - -```csharp -var client = new BybitRestClient(); -var result = await client.CopyTradingApi.ExchangeData.GetSymbolsAsync(); -``` - -```csharp -Task>> GetSymbolsAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/CopyTradingApi/IBybitRestClientCopyTradingApiTrading.md b/docs/ClientInfo/CopyTradingApi/IBybitRestClientCopyTradingApiTrading.md deleted file mode 100644 index 3e290c5a..00000000 --- a/docs/ClientInfo/CopyTradingApi/IBybitRestClientCopyTradingApiTrading.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -title: IBybitRestClientCopyTradingApiTrading -has_children: false -parent: IBybitRestClientCopyTradingApi -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > CopyTradingApi > Trading` -*Bybit trading endpoints, placing and managing positions.* - - -*** - -## CancelOrderAsync - -[https://bybit-exchange.github.io/docs/copy_trading/#t-ct_cancel_order](https://bybit-exchange.github.io/docs/copy_trading/#t-ct_cancel_order) -

- -*Cancel an active order* - -```csharp -var client = new BybitRestClient(); -var result = await client.CopyTradingApi.Trading.CancelOrderAsync(); -``` - -```csharp -Task> CancelOrderAsync(string? orderId = default, string? clientOrderId = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ orderId|Cancel by order id| -|_[Optional]_ clientOrderId|Cancel by client order id| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## CloseOrderAsync - -[https://bybit-exchange.github.io/docs/copy_trading/#t-ct_close_order](https://bybit-exchange.github.io/docs/copy_trading/#t-ct_close_order) -

- -*Close an order* - -```csharp -var client = new BybitRestClient(); -var result = await client.CopyTradingApi.Trading.CloseOrderAsync(/* parameters */); -``` - -```csharp -Task> CloseOrderAsync(string symbol, string? clientOrderId = default, string? parentOrderId = default, string? parentClientOrderId = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|Symbol| -|_[Optional]_ clientOrderId|Client order id| -|_[Optional]_ parentOrderId|Required if not passing parentClientOrderId| -|_[Optional]_ parentClientOrderId|Required if not passing parentOrderId| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## ClosePositionAsync - -[https://bybit-exchange.github.io/docs/copy_trading/#t-ct_positon_close](https://bybit-exchange.github.io/docs/copy_trading/#t-ct_positon_close) -

- -*Close a position* - -```csharp -var client = new BybitRestClient(); -var result = await client.CopyTradingApi.Trading.ClosePositionAsync(/* parameters */); -``` - -```csharp -Task ClosePositionAsync(string symbol, PositionMode positionMode, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|positionMode|Position mode| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOrdersAsync - -[https://bybit-exchange.github.io/docs/copy_trading/#t-ct_order_list](https://bybit-exchange.github.io/docs/copy_trading/#t-ct_order_list) -

- -*Get orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.CopyTradingApi.Trading.GetOrdersAsync(); -``` - -```csharp -Task>> GetOrdersAsync(string? symbol = default, string? orderId = default, string? clientOrderId = default, string? copyTradeOrderType = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ symbol|Filter by symbol| -|_[Optional]_ orderId|Filter by order id| -|_[Optional]_ clientOrderId|Filter by client order id| -|_[Optional]_ copyTradeOrderType|Filter by copy order type| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetPositionsAsync - -[https://bybit-exchange.github.io/docs/copy_trading/#t-ct_wallet_transfer](https://bybit-exchange.github.io/docs/copy_trading/#t-ct_wallet_transfer) -

- -*Get your positions* - -```csharp -var client = new BybitRestClient(); -var result = await client.CopyTradingApi.Trading.GetPositionsAsync(); -``` - -```csharp -Task>> GetPositionsAsync(string? symbol = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ symbol|Filter by symbol| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## PlaceOrderAsync - -[https://bybit-exchange.github.io/docs/copy_trading/#t-ct_create_order](https://bybit-exchange.github.io/docs/copy_trading/#t-ct_create_order) -

- -*Place an order* - -```csharp -var client = new BybitRestClient(); -var result = await client.CopyTradingApi.Trading.PlaceOrderAsync(/* parameters */); -``` - -```csharp -Task> PlaceOrderAsync(string symbol, OrderSide side, OrderType type, decimal quantity, decimal? price = default, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, string? clientOrderId = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|side|Order side| -|type|Order type| -|quantity|Quantity| -|_[Optional]_ price|Price| -|_[Optional]_ takeProfitPrice|Take profit price| -|_[Optional]_ stopLossPrice|Stop loss price| -|_[Optional]_ takeProfitTriggerType|Type of take-profit activation price| -|_[Optional]_ stopLossTriggerType|Type of stop-loss activation price| -|_[Optional]_ clientOrderId|Optional user defined id| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetLeverageAsync - -[https://bybit-exchange.github.io/docs/copy_trading/#t-ct_set_leverage](https://bybit-exchange.github.io/docs/copy_trading/#t-ct_set_leverage) -

- -*Set leverage* - -```csharp -var client = new BybitRestClient(); -var result = await client.CopyTradingApi.Trading.SetLeverageAsync(/* parameters */); -``` - -```csharp -Task SetLeverageAsync(string symbol, decimal buyLeverage, decimal sellLeverage, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|buyLeverage|Buy leverage| -|sellLeverage|Sell leverage| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetTradingStopAsync - -[https://bybit-exchange.github.io/docs/copy-trade/trade/trading-stop](https://bybit-exchange.github.io/docs/copy-trade/trade/trading-stop) -

- -*Set trading stop parameters for an existing order* - -```csharp -var client = new BybitRestClient(); -var result = await client.CopyTradingApi.Trading.SetTradingStopAsync(/* parameters */); -``` - -```csharp -Task SetTradingStopAsync(string symbol, string parentOrderId, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, string? parentClientOrderId = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|Symbol| -|parentOrderId|The parent order id| -|_[Optional]_ takeProfitPrice|New take profit price| -|_[Optional]_ stopLossPrice|New stop loss price| -|_[Optional]_ takeProfitTriggerType|New take profit trigger type| -|_[Optional]_ stopLossTriggerType|New stop loss trigger type| -|_[Optional]_ parentClientOrderId|Parent client order id| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/CopyTradingApi/IBybitSocketClientCopyTradingApi.md b/docs/ClientInfo/CopyTradingApi/IBybitSocketClientCopyTradingApi.md deleted file mode 100644 index 2014948b..00000000 --- a/docs/ClientInfo/CopyTradingApi/IBybitSocketClientCopyTradingApi.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -title: IBybitSocketClientCopyTradingApi -has_children: true -parent: Socket API documentation ---- -*[generated documentation]* -`BybitSocketClient > CopyTradingApi` -*Bybit copy trading streams* - - -*** - -## SubscribeToBalanceUpdatesAsync - -[https://bybit-exchange.github.io/docs/copy_trading/#t-websocketwallet](https://bybit-exchange.github.io/docs/copy_trading/#t-websocketwallet) -

- -*Subscribe to user balance updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.CopyTradingApi.SubscribeToBalanceUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToBalanceUpdatesAsync(Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToOrderUpdatesAsync - -[https://bybit-exchange.github.io/docs/copy_trading/#t-websocketorder](https://bybit-exchange.github.io/docs/copy_trading/#t-websocketorder) -

- -*Subscribe to user order updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.CopyTradingApi.SubscribeToOrderUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToOrderUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToPositionUpdatesAsync - -[https://bybit-exchange.github.io/docs/copy_trading/#t-websocketposition](https://bybit-exchange.github.io/docs/copy_trading/#t-websocketposition) -

- -*Subscribe to user position updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.CopyTradingApi.SubscribeToPositionUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToPositionUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToUserTradeUpdatesAsync - -[https://bybit-exchange.github.io/docs/copy_trading/#t-websocketexecution](https://bybit-exchange.github.io/docs/copy_trading/#t-websocketexecution) -

- -*Subscribe to user trade updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.CopyTradingApi.SubscribeToUserTradeUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToUserTradeUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

diff --git a/docs/ClientInfo/DerivativesApi/ContractApi/IBybitRestClientContractApi.md b/docs/ClientInfo/DerivativesApi/ContractApi/IBybitRestClientContractApi.md deleted file mode 100644 index 059d4a50..00000000 --- a/docs/ClientInfo/DerivativesApi/ContractApi/IBybitRestClientContractApi.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: IBybitRestClientContractApi -has_children: true -parent: IBybitRestClientDerivativesApi\ContractApi -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > DerivativesApi\ContractApi > ContractApi` -*Bybit contract API endpoints* - -*** -*Endpoints related to account settings, info or actions* -**[IBybitRestClientContractApiAccount](IBybitRestClientContractApiAccount.html) Account { get; }** -*** -*Endpoints related to orders and trades* -**[IBybitRestClientContractApiTrading](IBybitRestClientContractApiTrading.html) Trading { get; }** diff --git a/docs/ClientInfo/DerivativesApi/ContractApi/IBybitRestClientContractApiAccount.md b/docs/ClientInfo/DerivativesApi/ContractApi/IBybitRestClientContractApiAccount.md deleted file mode 100644 index 0e4a6f1f..00000000 --- a/docs/ClientInfo/DerivativesApi/ContractApi/IBybitRestClientContractApiAccount.md +++ /dev/null @@ -1,378 +0,0 @@ ---- -title: IBybitRestClientContractApiAccount -has_children: false -parent: IBybitRestClientDerivativesApi\ContractApi -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > DerivativesApi\ContractApi > ContractApiAccount` -*Bybit account endpoints. Account endpoints include balance info, withdraw/deposit info and requesting and account settings* - - -*** - -## GetBalancesAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-balance](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-balance) -

- -*Get wallet balances* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\ContractApi.ContractApiAccount.GetBalancesAsync(); -``` - -```csharp -Task>> GetBalancesAsync(string? asset = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetPositionAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-dv_myposition](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-dv_myposition) -

- -*Get user positions* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\ContractApi.ContractApiAccount.GetPositionAsync(); -``` - -```csharp -Task>>> GetPositionAsync(string? symbol = default, string? settleAsset = default, SettleDataFilter? dataFilter = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ symbol|Filter by symbol| -|_[Optional]_ settleAsset|Settle coin. Either symbol or settleCoin is required. If both are passed, symbol is used first.| -|_[Optional]_ dataFilter|Only work when settleCoin is passed. full: get all positions regardless zero or not based on settle coin. valid: get valid positions based on settle coin| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetProfitAndLossHistoryAsync - -

- -*Get user's closed profit and loss records. The results are ordered in descending order (the first item is the latest).* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\ContractApi.ContractApiAccount.GetProfitAndLossHistoryAsync(/* parameters */); -``` - -```csharp -Task>>> GetProfitAndLossHistoryAsync(string symbol, DateTime? startTime = default, DateTime? endTime = default, int? limit = default, string? cursor = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol| Symbol | -|_[Optional]_ startTime| Start timestamp point for result, in seconds | -|_[Optional]_ endTime| End timestamp point for result, in seconds | -|_[Optional]_ limit| Limit for data size per page, max size is 200. Default as showing 50 pieces of data per page. | -|_[Optional]_ cursor| Page turning mark | -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetTradingFeeRate - -[https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-tradingfeerate](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-tradingfeerate) -

- -*Get user trading fee rate* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\ContractApi.ContractApiAccount.GetTradingFeeRate(); -``` - -```csharp -Task>> GetTradingFeeRate(string? symbol = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ symbol| Symbol | -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetUserTradesAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-usertraderecords](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-usertraderecords) -

- -*Get executed user trades* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\ContractApi.ContractApiAccount.GetUserTradesAsync(/* parameters */); -``` - -```csharp -Task>>> GetUserTradesAsync(string symbol, string? orderId = default, DateTime? startTime = default, DateTime? endTime = default, TradeType? tradeType = default, int? limit = default, string? cursor = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ orderId|Filter by order id| -|_[Optional]_ startTime|Start timestamp in millisecond| -|_[Optional]_ endTime|End timestamp in millisecond| -|_[Optional]_ tradeType|Execution type| -|_[Optional]_ limit|Data quantity per page: Max data value per page is 50, and default value at 20| -|_[Optional]_ cursor|API pass-through| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetWalletFundRecords - -[https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-dv_walletrecords](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-dv_walletrecords) -

- -*Get user trading fee rate* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\ContractApi.ContractApiAccount.GetWalletFundRecords(); -``` - -```csharp -Task>>> GetWalletFundRecords(string? asset = default, DateTime? startTime = default, DateTime? endTime = default, WalletFundType? fundType = default, int? limit = default, string? cursor = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset| Coin | -|_[Optional]_ startTime|Start timestamp in milliseconds| -|_[Optional]_ endTime|End timestamp in milliseconds. The past year records ONLY| -|_[Optional]_ fundType|Wallet fund type| -|_[Optional]_ limit|Data quantity per page: Max data value per page is 50, and default value at 20| -|_[Optional]_ cursor|API pass-through| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetAutoAddMarginAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-setautoaddmargin](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-setautoaddmargin) -

- -*Set auto add margin switch* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\ContractApi.ContractApiAccount.SetAutoAddMarginAsync(/* parameters */); -``` - -```csharp -Task SetAutoAddMarginAsync(string symbol, OrderSide side, bool autoAddMargin, PositionMode? positionMode = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|Symbol| -|side|Side| -|autoAddMargin|Auto add or not| -|_[Optional]_ positionMode|Position mode| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetFullPartialPositionModeAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-dv_switchmode](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-dv_switchmode) -

- -*Switch between full or partial Stop loss/Take profit mode* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\ContractApi.ContractApiAccount.SetFullPartialPositionModeAsync(/* parameters */); -``` - -```csharp -Task SetFullPartialPositionModeAsync(string symbol, StopLossTakeProfitMode mode, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|mode|New mode| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetLeverageAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-setleverage](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-setleverage) -

- -*Set leverage* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\ContractApi.ContractApiAccount.SetLeverageAsync(/* parameters */); -``` - -```csharp -Task SetLeverageAsync(string symbol, decimal buyLeverage, decimal sellLeverage, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|buyLeverage|Buy leverage| -|sellLeverage|Sell leverage| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetMarginMode - -[https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-dv_setmarginmode](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-dv_setmarginmode) -

- -*Get user trading fee rate* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\ContractApi.ContractApiAccount.SetMarginMode(/* parameters */); -``` - -```csharp -Task SetMarginMode(MarginMode marginMode, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|marginMode| Margin mode | -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetPositionModeAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-dv_switchpositionmode](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-dv_switchpositionmode) -

- -*Switch position mode. If you are in One-Way Mode, you can only open one position on Buy or Sell side;* -*If you are in Hedge Mode, you can open both Buy and Sell side positions simultaneously.* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\ContractApi.ContractApiAccount.SetPositionModeAsync(/* parameters */); -``` - -```csharp -Task SetPositionModeAsync(PositionMode hedgeMode, string? symbol = default, string? asset = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|hedgeMode|Hedge mode. OneWay/Hedge are supported| -|_[Optional]_ symbol|The symbol| -|_[Optional]_ asset|Currency alias| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetRiskLimitAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-setrisklimit](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-setrisklimit) -

- -*Set position risk* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\ContractApi.ContractApiAccount.SetRiskLimitAsync(/* parameters */); -``` - -```csharp -Task SetRiskLimitAsync(string symbol, long riskId, PositionMode? positionMode = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|riskId|The risk id to set| -|_[Optional]_ positionMode|Position mode| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetTradeModeAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-dv_marginswitch](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-dv_marginswitch) -

- -*Switch cross margin mode/isolated margin mode* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\ContractApi.ContractApiAccount.SetTradeModeAsync(/* parameters */); -``` - -```csharp -Task SetTradeModeAsync(string symbol, TradeMode tradeMode, decimal buyLeverage, decimal sellLeverage, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|tradeMode|Cross/isolated mode| -|buyLeverage|Buy leverage| -|sellLeverage|Sell leverage| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/DerivativesApi/ContractApi/IBybitRestClientContractApiTrading.md b/docs/ClientInfo/DerivativesApi/ContractApi/IBybitRestClientContractApiTrading.md deleted file mode 100644 index 948d7b39..00000000 --- a/docs/ClientInfo/DerivativesApi/ContractApi/IBybitRestClientContractApiTrading.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -title: IBybitRestClientContractApiTrading -has_children: false -parent: IBybitRestClientDerivativesApi\ContractApi -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > DerivativesApi\ContractApi > ContractApiTrading` -*Bybit trading endpoints, placing and managing orders.* - - -*** - -## CancelAllOrdersAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-contract_cancelallorders](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-contract_cancelallorders) -

- -*Cancel all orders that are unfilled or partially filled. Fully filled orders cannot be cancelled.* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\ContractApi.ContractApiTrading.CancelAllOrdersAsync(); -``` - -```csharp -Task>> CancelAllOrdersAsync(string? symbol = default, string? settleAsset = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ symbol|The symbol| -|_[Optional]_ settleAsset|Cancel orders by settle coin| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## CancelOrderAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-contract_cancelorder](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-contract_cancelorder) -

- -*Cancel an order, either orderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\ContractApi.ContractApiTrading.CancelOrderAsync(/* parameters */); -``` - -```csharp -Task> CancelOrderAsync(string symbol, string? orderId = default, string? clientOrderId = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ orderId|The id of the order to cancel| -|_[Optional]_ clientOrderId|The client order id of the conditional order to cancel| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOpenOrdersRealTimeAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-contract_getrealtimeorder](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-contract_getrealtimeorder) -

- -*Query real-time order information* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\ContractApi.ContractApiTrading.GetOpenOrdersRealTimeAsync(); -``` - -```csharp -Task>>> GetOpenOrdersRealTimeAsync(string? symbol = default, string? orderId = default, string? clientOrderId = default, string? settleAsset = default, OrderFilter? orderFilter = default, int? limit = default, string? cursor = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ symbol|The symbol| -|_[Optional]_ orderId|Filter by order id| -|_[Optional]_ clientOrderId|Filter by client order id| -|_[Optional]_ settleAsset|Settle coin. Either symbol or settleCoin is required. If both are passed, symbol is used first.| -|_[Optional]_ orderFilter|Conditional order or active order| -|_[Optional]_ limit| Limit for data size per page, max size is 200. Default as showing 50 pieces of data per page. | -|_[Optional]_ cursor| Page turning mark | -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOrdersAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-contract_getorder](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-contract_getorder) -

- -*Get orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\ContractApi.ContractApiTrading.GetOrdersAsync(/* parameters */); -``` - -```csharp -Task>>> GetOrdersAsync(string symbol, string? orderId = default, string? clientOrderId = default, OrderStatus? status = default, OrderFilter? orderFilter = default, int? limit = default, string? cursor = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ orderId|Filter by order id| -|_[Optional]_ clientOrderId|Filter by client order id| -|_[Optional]_ status|Filter by status| -|_[Optional]_ orderFilter|Conditional order or active order| -|_[Optional]_ limit| Limit for data size per page, max size is 200. Default as showing 50 pieces of data per page. | -|_[Optional]_ cursor| Page turning mark | -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## PlaceOrderAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-dv_placeorder](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-dv_placeorder) -

- -*Place a new order* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\ContractApi.ContractApiTrading.PlaceOrderAsync(/* parameters */); -``` - -```csharp -Task> PlaceOrderAsync(string symbol, OrderSide side, OrderType type, decimal quantity, TimeInForce timeInForce, bool? reduceOnly = default, bool? closeOnTrigger = default, decimal? price = default, string? clientOrderId = default, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, PositionMode? positionMode = default, StopLossTakeProfitMode? stopLossTakeProfitMode = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|side|Order side| -|type|Order type| -|quantity|Quantity| -|timeInForce|Time in force| -|_[Optional]_ reduceOnly|True means your position can only reduce in size if this order is triggered| -|_[Optional]_ closeOnTrigger|For a closing order. It can only reduce your position, not increase it. If the account has insufficient available balance when the closing order is triggered, then other active orders of similar contracts will be cancelled or reduced. It can be used to ensure your stop loss reduces your position regardless of current available margin.| -|_[Optional]_ price|Price| -|_[Optional]_ clientOrderId|Client order id| -|_[Optional]_ takeProfitPrice|Take profit price, only take effect upon opening the position| -|_[Optional]_ stopLossPrice|Stop loss price, only take effect upon opening the position| -|_[Optional]_ takeProfitTriggerType|Take profit trigger price type, default: LastPrice| -|_[Optional]_ stopLossTriggerType|Stop loss trigger price type, default: LastPrice| -|_[Optional]_ positionMode|Position mode| -|_[Optional]_ stopLossTakeProfitMode|StopLoss / TakeProfit mode| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## ReplaceOrderAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_replaceorder](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_replaceorder) -

- -*Change an exising order. Either orderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\ContractApi.ContractApiTrading.ReplaceOrderAsync(/* parameters */); -``` - -```csharp -Task> ReplaceOrderAsync(string symbol, string? orderId = default, string? clientOrderId = default, decimal? quantity = default, decimal? price = default, decimal? triggerPrice = default, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, TriggerType? triggerType = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ orderId|Order ID. Required if not passing orderLinkId| -|_[Optional]_ clientOrderId|Client order id| -|_[Optional]_ quantity|Quantity| -|_[Optional]_ price|Quantity| -|_[Optional]_ triggerPrice|Trigger price| -|_[Optional]_ takeProfitPrice|Take profit price, only take effect upon opening the position| -|_[Optional]_ stopLossPrice|Stop loss price, only take effect upon opening the position| -|_[Optional]_ takeProfitTriggerType|Take profit trigger price type, default: LastPrice| -|_[Optional]_ stopLossTriggerType|Stop loss trigger price type, default: LastPrice>| -|_[Optional]_ triggerType|Trigger price type: Market price/Mark price| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetTradingStop - -

- -*Set take profit, stop loss, and trailing stop for your open position. If using partial mode, TP/SL/TS orders will not close your entire position.* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\ContractApi.ContractApiTrading.SetTradingStop(/* parameters */); -``` - -```csharp -Task SetTradingStop(string symbol, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, decimal? activePrice = default, decimal? trailingStop = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, decimal? stopLossSize = default, decimal? takeProfitSize = default, PositionMode? positionMode = default, StopLossTakeProfitMode? stopLossTakeProfitMode = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|Symbol| -|_[Optional]_ takeProfitPrice|Cannot be less than 0, 0 means cancel TP| -|_[Optional]_ stopLossPrice|Cannot be less than 0, 0 means cancel SL| -|_[Optional]_ activePrice|Trailing stop trigger price. Trailing stop will only be triggered when this price is touched | -|_[Optional]_ trailingStop|Cannot be less than 0, 0 means cancel TS| -|_[Optional]_ takeProfitTriggerType|Take profit trigger price type| -|_[Optional]_ stopLossTriggerType|Stop loss trigger price type| -|_[Optional]_ stopLossSize|Stop loss quantity| -|_[Optional]_ takeProfitSize|Take profit quantity| -|_[Optional]_ positionMode|Position mode| -|_[Optional]_ stopLossTakeProfitMode|StopLoss / TakeProfit mode| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/DerivativesApi/ContractApi/IBybitSocketClientContractApi.md b/docs/ClientInfo/DerivativesApi/ContractApi/IBybitSocketClientContractApi.md deleted file mode 100644 index 2f004528..00000000 --- a/docs/ClientInfo/DerivativesApi/ContractApi/IBybitSocketClientContractApi.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -title: IBybitSocketClientContractApi -has_children: true -parent: IBybitSocketClientDerivativesApi\ContractApi -grand_parent: Socket API documentation ---- -*[generated documentation]* -`BybitSocketClient > DerivativesApi\ContractApi > ContractApi` -*Bybit Contract streams* - - -*** - -## SubscribeToBalanceUpdatesAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-websocketwallet](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-websocketwallet) -

- -*Subscribe to user balance updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.DerivativesApi\ContractApi.ContractApi.SubscribeToBalanceUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToBalanceUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToOrderUpdatesAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-websocketorder](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-websocketorder) -

- -*Subscribe to user order updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.DerivativesApi\ContractApi.ContractApi.SubscribeToOrderUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToOrderUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToPositionUpdatesAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-websocketposition](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-websocketposition) -

- -*Subscribe to user position updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.DerivativesApi\ContractApi.ContractApi.SubscribeToPositionUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToPositionUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToUserTradeUpdatesAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-websocketexecution](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-websocketexecution) -

- -*Subscribe to user trade updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.DerivativesApi\ContractApi.ContractApi.SubscribeToUserTradeUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToUserTradeUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

diff --git a/docs/ClientInfo/DerivativesApi/IBybitRestClientDerivativesApi.md b/docs/ClientInfo/DerivativesApi/IBybitRestClientDerivativesApi.md deleted file mode 100644 index 41acb0ef..00000000 --- a/docs/ClientInfo/DerivativesApi/IBybitRestClientDerivativesApi.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: IBybitRestClientDerivativesApi -has_children: true -parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > DerivativesApi` -*Bybit Derivatives v3 endpoints* - -*** -*Bybit Contract endpoints* -**[IBybitRestClientContractApi](ContractApi/IBybitRestClientContractApi.html) ContractApi { get; }** -*** -*Endpoints related to retrieving market and system data* -**[IBybitRestClientDerivativesApiExchangeData](IBybitRestClientDerivativesApiExchangeData.html) ExchangeData { get; }** -*** -*Bybit Unified Margin endpoints* -**[IBybitRestClientUnifiedMarginApi](UnifiedMarginApi/IBybitRestClientUnifiedMarginApi.html) UnifiedMarginApi { get; }** diff --git a/docs/ClientInfo/DerivativesApi/IBybitRestClientDerivativesApiExchangeData.md b/docs/ClientInfo/DerivativesApi/IBybitRestClientDerivativesApiExchangeData.md deleted file mode 100644 index 044aac51..00000000 --- a/docs/ClientInfo/DerivativesApi/IBybitRestClientDerivativesApiExchangeData.md +++ /dev/null @@ -1,351 +0,0 @@ ---- -title: IBybitRestClientDerivativesApiExchangeData -has_children: false -parent: IBybitRestClientDerivativesApi -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > DerivativesApi > ExchangeData` -*Bybit exchange data endpoints. Exchange data includes market data (tickers, order books, etc) and system status.* - - -*** - -## GetFundingRateAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_historyfundingratehead](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_historyfundingratehead) -

- -*Get funding rate history* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi.ExchangeData.GetFundingRateAsync(/* parameters */); -``` - -```csharp -Task>> GetFundingRateAsync(Category category, string symbol, DateTime? from = default, DateTime? to = default, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Derivatives products category. If category is not passed, then return ""For now, linear inverse including inverse futures are available| -|symbol|The symbol| -|_[Optional]_ from|Start time of the data| -|_[Optional]_ to|End time of the data| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetIndexPriceKlinesAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_indexpricekline](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_indexpricekline) -

- -*Get index price klines* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi.ExchangeData.GetIndexPriceKlinesAsync(/* parameters */); -``` - -```csharp -Task>> GetIndexPriceKlinesAsync(Category category, string symbol, KlineInterval interval, DateTime from, DateTime to, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Derivatives products category. If category is not passed, then return ""For now, linear inverse including inverse futures are available| -|symbol|Symbol of the klines| -|interval|Interval of the kline data| -|from|Start time of the data| -|to|End time of the data| -|_[Optional]_ limit|Max amount of candles| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetKlinesAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_querykline](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_querykline) -

- -*Get price klines* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi.ExchangeData.GetKlinesAsync(/* parameters */); -``` - -```csharp -Task>> GetKlinesAsync(Category category, string symbol, KlineInterval interval, DateTime from, DateTime to, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Derivatives products category. If category is not passed, then return ""For now, linear inverse including inverse futures are available| -|symbol|Symbol of the klines| -|interval|Interval of the kline data| -|from|Start time of the data| -|to|End time of the data| -|_[Optional]_ limit|Max amount of candles| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetMarkPriceKlinesAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_markpricekline](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_markpricekline) -

- -*Get mark price klines* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi.ExchangeData.GetMarkPriceKlinesAsync(/* parameters */); -``` - -```csharp -Task>> GetMarkPriceKlinesAsync(Category category, string symbol, KlineInterval interval, DateTime from, DateTime to, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Derivatives products category. If category is not passed, then return ""For now, linear inverse including inverse futures are available| -|symbol|Symbol of the klines| -|interval|Interval of the kline data| -|from|Start time of the data| -|to|End time of the data| -|_[Optional]_ limit|Max amount of candles| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOpenInterestAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_marketopeninterest](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_marketopeninterest) -

- -*Gets the total amount of unsettled contracts. In other words, the total number of contracts held in open positions.* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi.ExchangeData.GetOpenInterestAsync(/* parameters */); -``` - -```csharp -Task>> GetOpenInterestAsync(Category category, string symbol, OpenInterestInterval interval, DataPeriod period, DateTime? from = default, DateTime? to = default, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Derivatives products category. If category is not passed, then return ""For now, linear inverse including inverse futures are available| -|symbol|The symbol| -|interval| Open interest interval type | -|period|The period of data| -|_[Optional]_ from|Start time of the data| -|_[Optional]_ to|End time of the data| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOptionDeliveryPriceAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_optiondeliveryhead](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_optiondeliveryhead) -

- -*Get option delivery price* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi.ExchangeData.GetOptionDeliveryPriceAsync(); -``` - -```csharp -Task>>> GetOptionDeliveryPriceAsync(Category? category = default, string? symbol = default, string? baseAsset = default, int? limit = default, string? cursor = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ category|Derivatives products category. If category is not passed, then return ""For now, linear inverse including inverse futures are available| -|_[Optional]_ symbol|The symbol| -|_[Optional]_ baseAsset|Base coin. Only valid when category=option. If not passed, BTC by default.| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ cursor|API pass-through| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOrderBookAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_orderbook](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_orderbook) -

- -*Get the current order book for a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi.ExchangeData.GetOrderBookAsync(/* parameters */); -``` - -```csharp -Task> GetOrderBookAsync(string symbol, Category? category = default, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ category|Derivatives products category. If category is not passed, then return ""For now, linear inverse option are available| -|_[Optional]_ limit|25 by default, 500 is max. If option, only 25 is available| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetRiskLimitAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_risklimithead](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_risklimithead) -

- -*Get Risk Limit* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi.ExchangeData.GetRiskLimitAsync(/* parameters */); -``` - -```csharp -Task>> GetRiskLimitAsync(Category category, string symbol, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Derivatives products category. If category is not passed, then return ""For now, linear inverse including inverse futures are available| -|symbol|The symbol| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetServerTimeAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-servertime](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-servertime) -

- -*Get the server time* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi.ExchangeData.GetServerTimeAsync(); -``` - -```csharp -Task> GetServerTimeAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetSymbolsAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_instrhead](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_instrhead) -

- -*Get all supported symbols* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi.ExchangeData.GetSymbolsAsync(/* parameters */); -``` - -```csharp -Task>>> GetSymbolsAsync(Category category, string? symbol = default, string? baseAsset = default, int? limit = default, string? cursor = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category| Derivatives products category.If category is not passed, then return ""For now, linear inverse option are available| -|_[Optional]_ symbol|Symbol| -|_[Optional]_ baseAsset|Base coin.Only valid when category = option.If not passed, BTC by default.| -|_[Optional]_ limit|Limit for data size per cursor, max size is 1000. Default as showing 500 pieces of data per cursor| -|_[Optional]_ cursor|API pass-through| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetTickerAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_tickerhead](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_tickerhead) -

- -*The ticker info for a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi.ExchangeData.GetTickerAsync(/* parameters */); -``` - -```csharp -Task>> GetTickerAsync(Category category, string? symbol = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Derivatives products category. If category is not passed, then return ""For now, linear inverse option are available| -|_[Optional]_ symbol|The symbol| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetTradeHistoryAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_publictradingrecords](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_publictradingrecords) -

- -*Get Trade history* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi.ExchangeData.GetTradeHistoryAsync(/* parameters */); -``` - -```csharp -Task>> GetTradeHistoryAsync(Category category, string symbol, string? baseAsset = default, OptionType? optionType = default, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Derivatives products category. If category is not passed, then return ""For now, linear inverse including inverse futures are available| -|symbol|The symbol| -|_[Optional]_ baseAsset|Base coin. Only valid when category=option. If not passed, BTC by default.| -|_[Optional]_ optionType|Trading type of option| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/DerivativesApi/IBybitSocketClientDerivativesPublicApi.md b/docs/ClientInfo/DerivativesApi/IBybitSocketClientDerivativesPublicApi.md deleted file mode 100644 index bb3fc992..00000000 --- a/docs/ClientInfo/DerivativesApi/IBybitSocketClientDerivativesPublicApi.md +++ /dev/null @@ -1,236 +0,0 @@ ---- -title: IBybitSocketClientDerivativesPublicApi -has_children: true -parent: IBybitSocketClientDerivativesApi -grand_parent: Socket API documentation ---- -*[generated documentation]* -`BybitSocketClient > DerivativesApi > DerivativesPublicApi` -*Bybit public Derivatives streams* - - -*** - -## SubscribeToKlinesUpdatesAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websocketkline](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websocketkline) -

- -*Subscribe to kline (candlestick) updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.DerivativesApi.DerivativesPublicApi.SubscribeToKlinesUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToKlinesUpdatesAsync(StreamDerivativesCategory category, IEnumerable symbols, KlineInterval interval, Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Asset category| -|symbols|List of symbols to receive updates for| -|interval|The interval of the klines| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToKlineUpdatesAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websocketkline](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websocketkline) -

- -*Subscribe to kline (candlestick) updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.DerivativesApi.DerivativesPublicApi.SubscribeToKlineUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToKlineUpdatesAsync(StreamDerivativesCategory category, string symbol, KlineInterval interval, Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Asset category| -|symbol|The symbol to receive updates for| -|interval|The interval of the klines| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToOrderBooksUpdatesAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websocketorderbookdepth](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websocketorderbookdepth) -

- -*Subscribe to orderbook updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.DerivativesApi.DerivativesPublicApi.SubscribeToOrderBooksUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToOrderBooksUpdatesAsync(StreamDerivativesCategory category, IEnumerable symbols, int limit, Action> snapshotHandler, Action> deltaHandler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Asset category| -|symbols|List of symbols to receive updates for| -|limit|The amount of rows to receive updates for. Either 1, 25, 50, 100, 200.| -|snapshotHandler|The event handler for the snapshot messages| -|deltaHandler|The event handler for the update messages| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToOrderBookUpdatesAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websocketorderbookdepth](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websocketorderbookdepth) -

- -*Subscribe to orderbook updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.DerivativesApi.DerivativesPublicApi.SubscribeToOrderBookUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToOrderBookUpdatesAsync(StreamDerivativesCategory category, string symbol, int limit, Action> snapshotHandler, Action> deltaHandler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Asset category| -|symbol|The symbol to receive updates for| -|limit|The amount of rows to receive updates for. Either 1, 25, 50, 100, 200.| -|snapshotHandler|The event handler for the snapshot messages| -|deltaHandler|The event handler for the update messages| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToTickersUpdatesAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websocketticker_v3](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websocketticker_v3) -

- -*Subscribe to ticker updates. Note that for a symbol the first update is a snapshot, containing all info. After that only partial updates are given for* -*properties which have changed. If a property in the update is `null` it isn't changed and should be ignored.* - -```csharp -var client = new BybitSocketClient(); -var result = await client.DerivativesApi.DerivativesPublicApi.SubscribeToTickersUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTickersUpdatesAsync(StreamDerivativesCategory category, IEnumerable symbols, Action> snapshotHandler, Action> updateHandler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Asset category| -|symbols|List of symbols to receive updates for| -|snapshotHandler| Snapshot handler| -|updateHandler| Update handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToTickerUpdatesAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websocketticker_v3](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websocketticker_v3) -

- -*Subscribe to ticker updates. Note that for a symbol the first update is a snapshot, containing all info. After that only partial updates are given for* -*properties which have changed. If a property in the update is `null` it isn't changed and should be ignored.* - -```csharp -var client = new BybitSocketClient(); -var result = await client.DerivativesApi.DerivativesPublicApi.SubscribeToTickerUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTickerUpdatesAsync(StreamDerivativesCategory category, string symbol, Action> snapshotHandler, Action> updateHandler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Asset category| -|symbol|The symbol to receive updates for| -|snapshotHandler| Snapshot handler| -|updateHandler| Update handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToTradesUpdatesAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websockettrade](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websockettrade) -

- -*Subscribe to public trade updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.DerivativesApi.DerivativesPublicApi.SubscribeToTradesUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTradesUpdatesAsync(StreamDerivativesCategory category, IEnumerable symbols, Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Asset category| -|symbols|List of symbols to receive updates for| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToTradeUpdatesAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websockettrade](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websockettrade) -

- -*Subscribe to public trade updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.DerivativesApi.DerivativesPublicApi.SubscribeToTradeUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTradeUpdatesAsync(StreamDerivativesCategory category, string symbol, Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Asset category| -|symbol|The symbol to receive updates for| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

diff --git a/docs/ClientInfo/DerivativesApi/UnifiedMarginApi/IBybitRestClientUnifiedMarginApi.md b/docs/ClientInfo/DerivativesApi/UnifiedMarginApi/IBybitRestClientUnifiedMarginApi.md deleted file mode 100644 index 53870d63..00000000 --- a/docs/ClientInfo/DerivativesApi/UnifiedMarginApi/IBybitRestClientUnifiedMarginApi.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: IBybitRestClientUnifiedMarginApi -has_children: true -parent: IBybitRestClientDerivativesApi\UnifiedMarginApi -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > DerivativesApi\UnifiedMarginApi > UnifiedMarginApi` -*Bybit Unified Margin API endpoints* - -*** -*Endpoints related to account settings, info or actions* -**[IBybitRestClientUnifiedMarginApiAccount](IBybitRestClientUnifiedMarginApiAccount.html) Account { get; }** -*** -*Endpoints related to orders and trades* -**[IBybitRestClientUnifiedMarginApiTrading](IBybitRestClientUnifiedMarginApiTrading.html) Trading { get; }** diff --git a/docs/ClientInfo/DerivativesApi/UnifiedMarginApi/IBybitRestClientUnifiedMarginApiAccount.md b/docs/ClientInfo/DerivativesApi/UnifiedMarginApi/IBybitRestClientUnifiedMarginApiAccount.md deleted file mode 100644 index fe1a11db..00000000 --- a/docs/ClientInfo/DerivativesApi/UnifiedMarginApi/IBybitRestClientUnifiedMarginApiAccount.md +++ /dev/null @@ -1,392 +0,0 @@ ---- -title: IBybitRestClientUnifiedMarginApiAccount -has_children: false -parent: IBybitRestClientDerivativesApi\UnifiedMarginApi -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > DerivativesApi\UnifiedMarginApi > UnifiedMarginApiAccount` -*Bybit account endpoints. Account endpoints include balance info, withdraw/deposit info and requesting and account settings* - - -*** - -## ExchangeCoinsAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_queryexchangerecords](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_queryexchangerecords) -

- -*Exchange Coins* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApiAccount.ExchangeCoinsAsync(); -``` - -```csharp -Task>> ExchangeCoinsAsync(string? fromCoint = default, string? toCoint = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ fromCoint|| -|_[Optional]_ toCoint|| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetBorrowHistoryAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_interestbillstatement](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_interestbillstatement) -

- -*Get Borrow History* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApiAccount.GetBorrowHistoryAsync(); -``` - -```csharp -Task>>> GetBorrowHistoryAsync(string? asset = default, DateTime? startTime = default, DateTime? endTime = default, SearchDirection? direction = default, int? limit = default, string? cursor = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|USDC, USDT, BTC, and ETH| -|_[Optional]_ startTime|Starting timestamp| -|_[Optional]_ endTime|Ending timestamp| -|_[Optional]_ direction|| -|_[Optional]_ limit|| -|_[Optional]_ cursor|| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetBorrowRateAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_queryloaninterest](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_queryloaninterest) -

- -*Get borrow rate* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApiAccount.GetBorrowRateAsync(); -``` - -```csharp -Task>> GetBorrowRateAsync(string? asset = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|Only for UDDC, USDT. If not passed, USDT-USDC interests are returned. You could pass multiple currency separated by comma, e.a USDC,USDT| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetPositionAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_myposition](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_myposition) -

- -*Get user positions* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApiAccount.GetPositionAsync(/* parameters */); -``` - -```csharp -Task>>> GetPositionAsync(Category category, string? symbol = default, string? baseAsset = default, SearchDirection? direction = default, int? limit = default, string? cursor = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Type of derivatives product: linear or option| -|_[Optional]_ symbol|Name of Contract| -|_[Optional]_ baseAsset|Base coin. When category=option. If not passed, BTC by default.| -|_[Optional]_ direction|| -|_[Optional]_ limit|| -|_[Optional]_ cursor|| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetProfitAndLossHistoryAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_usertraderecords7day](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_usertraderecords7day) -

- -*Get 7-day Trading History* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApiAccount.GetProfitAndLossHistoryAsync(/* parameters */); -``` - -```csharp -Task>>> GetProfitAndLossHistoryAsync(Category category, string? symbol = default, string? baseAsset = default, string? orderId = default, string? clientOrderId = default, OrderFilter? orderFilter = default, DateTime? startTime = default, DateTime? endTime = default, TradeType? type = default, SearchDirection? direction = default, int? limit = default, string? cursor = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|| -|_[Optional]_ symbol|The symbol| -|_[Optional]_ baseAsset|Base coin. When category=option. If not passed, BTC by default.| -|_[Optional]_ orderId|Filter by order id| -|_[Optional]_ clientOrderId|Filter by client order id| -|_[Optional]_ orderFilter|Conditional order or active order| -|_[Optional]_ startTime|Filter by startTime| -|_[Optional]_ endTime|Filter by endTime| -|_[Optional]_ type|Filter by type| -|_[Optional]_ direction|Search direction| -|_[Optional]_ limit|Data quantity per page: Max data value per page is 50, and default value at 20| -|_[Optional]_ cursor|API pass-through| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetTransactionLogAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_querytransactionlogs](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_querytransactionlogs) -

- -*Query trading history* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApiAccount.GetTransactionLogAsync(/* parameters */); -``` - -```csharp -Task>>> GetTransactionLogAsync(Category category, string asset, string? baseAsset = default, DateTime? startTime = default, DateTime? endTime = default, SearchDirection? direction = default, int? limit = default, string? cursor = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category| Type of derivatives product: linear or option| -|asset|USDC, USDT, BTC, and ETH| -|_[Optional]_ baseAsset|Base coin| -|_[Optional]_ startTime|Starting timestamp| -|_[Optional]_ endTime|Ending timestamp| -|_[Optional]_ direction|| -|_[Optional]_ limit|| -|_[Optional]_ cursor|| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetWalletBalance - -

- -*Query wallet balance* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApiAccount.GetWalletBalance(); -``` - -```csharp -Task> GetWalletBalance(string? asset = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|Currency alias. If the parameter coin is not passed, all wallet balance will be returned. Multiple parameters can be passed, which should be separated using commas, such as USDC, USDT| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## IsUMAEnabled - -

- -*Check, if Unified Margin Account enabled for current credentials* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApiAccount.IsUMAEnabled(); -``` - -```csharp -Task> IsUMAEnabled(); -``` - -|Parameter|Description| -|---|---| - -

- -*** - -## SetFullPartialPositionModeAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_switchmode](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_switchmode) -

- -*Switch between full or partial Stop loss/Take profit mode* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApiAccount.SetFullPartialPositionModeAsync(/* parameters */); -``` - -```csharp -Task SetFullPartialPositionModeAsync(Category category, string symbol, StopLossTakeProfitMode mode, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Type of derivatives product: linear or option| -|symbol|The symbol| -|mode|New mode| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetLeverageAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_setleverage](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_setleverage) -

- -*Modify leverage* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApiAccount.SetLeverageAsync(/* parameters */); -``` - -```csharp -Task SetLeverageAsync(Category category, string symbol, decimal buyLeverage, decimal cellLeverage, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Type of derivatives product: linear or option| -|symbol|Name of Contract| -|buyLeverage|leverage of the corresponding risk limit| -|cellLeverage|leverage of the corresponding risk limit| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetRiskLimitAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_setrisklimit](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_setrisklimit) -

- -*Set position risk* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApiAccount.SetRiskLimitAsync(/* parameters */); -``` - -```csharp -Task SetRiskLimitAsync(Category category, string symbol, long riskId, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Type of derivatives product: linear or option| -|symbol|The symbol| -|riskId|The risk id to set| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetSlTpAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_switchmode](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_switchmode) -

- -*Set position TP/SL and trailing stop.* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApiAccount.SetSlTpAsync(/* parameters */); -``` - -```csharp -Task SetSlTpAsync(Category category, string symbol, decimal? takeProfit = default, decimal? stopLoss = default, decimal? trailingStop = default, TriggerType? tpTriggerBy = default, TriggerType? slTriggerBy = default, decimal? activePrice = default, decimal? slSize = default, decimal? tpSize = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category| Derivatives products category. If category is not passed, then return ""For now, linear is available| -|symbol| Name of Contract| -|_[Optional]_ takeProfit| ≥ 0, if = 0, cancel take-profit (TP)| -|_[Optional]_ stopLoss| ≥ 0, if = 0, cancel stop-loss (SL)| -|_[Optional]_ trailingStop| ≥ 0, if = 0, cancel trailing stop (TS)| -|_[Optional]_ tpTriggerBy|Type of take-profit activation price, LastPrice by default| -|_[Optional]_ slTriggerBy|Type of stop-loss activation price, LastPrice by default| -|_[Optional]_ activePrice|Trailing stop trigger price. Trailing stop will only be triggered when this price is touched (trailing stop will be immediately triggered by default)| -|_[Optional]_ slSize|Quantity of stop-loss orders with the TP/SL mode on selected positions| -|_[Optional]_ tpSize|Quantity of take-profit orders with the TP/SL mode on selected positions| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## TransferFundsAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_transfer](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_transfer) -

- -*Fund transfer between accounts* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApiAccount.TransferFundsAsync(/* parameters */); -``` - -```csharp -Task> TransferFundsAsync(string transferId, decimal amount, string currency, AccountType fromAccountType, AccountType toAccountType, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|transferId|UUID, globally unique| -|amount|Exchanged amount| -|currency|Currency alias| -|fromAccountType|Account type| -|toAccountType|Account type| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/DerivativesApi/UnifiedMarginApi/IBybitRestClientUnifiedMarginApiTrading.md b/docs/ClientInfo/DerivativesApi/UnifiedMarginApi/IBybitRestClientUnifiedMarginApiTrading.md deleted file mode 100644 index d6d3974f..00000000 --- a/docs/ClientInfo/DerivativesApi/UnifiedMarginApi/IBybitRestClientUnifiedMarginApiTrading.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -title: IBybitRestClientUnifiedMarginApiTrading -has_children: false -parent: IBybitRestClientDerivativesApi\UnifiedMarginApi -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > DerivativesApi\UnifiedMarginApi > UnifiedMarginApiTrading` -*Bybit trading endpoints, placing and managing orders.* - - -*** - -## CancelAllOrdersAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_cancelallorders](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_cancelallorders) -

- -*Cancel all active orders for a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApiTrading.CancelAllOrdersAsync(/* parameters */); -``` - -```csharp -Task>> CancelAllOrdersAsync(Category category, string? baseAsset = default, string? settleAsset = default, string? symbol = default, OrderFilter? orderFilter = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Type of derivatives product: linear or option| -|_[Optional]_ baseAsset|Base Coin| -|_[Optional]_ settleAsset|Settle Coin. It's invalid for option| -|_[Optional]_ symbol|The symbol| -|_[Optional]_ orderFilter|Conditional order or active order| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## CancelOrderAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_cancelorder](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_cancelorder) -

- -*Cancel an order, either orderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApiTrading.CancelOrderAsync(/* parameters */); -``` - -```csharp -Task> CancelOrderAsync(Category category, string symbol, string? orderId = default, string? clientOrderId = default, OrderFilter? orderFilter = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Type of derivatives product: linear or option| -|symbol|The symbol| -|_[Optional]_ orderId|The id of the order to cancel| -|_[Optional]_ clientOrderId|The client order id of the conditional order to cancel| -|_[Optional]_ orderFilter|Conditional order or active order| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOpenOrdersRealTimeAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_queryorderrealtime](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_queryorderrealtime) -

- -*Get orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApiTrading.GetOpenOrdersRealTimeAsync(/* parameters */); -``` - -```csharp -Task>>> GetOpenOrdersRealTimeAsync(Category category, string? symbol = default, string? baseAsset = default, string? orderId = default, string? clientOrderId = default, OrderFilter? orderFilter = default, SearchDirection? direction = default, int? limit = default, string? cursor = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|| -|_[Optional]_ symbol|The symbol| -|_[Optional]_ baseAsset|Base coin. When category=option. If not passed, BTC by default.| -|_[Optional]_ orderId|Filter by order id| -|_[Optional]_ clientOrderId|Filter by client order id| -|_[Optional]_ orderFilter|Conditional order or active order| -|_[Optional]_ direction|Search direction| -|_[Optional]_ limit|Data quantity per page: Max data value per page is 50, and default value at 20| -|_[Optional]_ cursor|API pass-through| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOrdersAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_getorder](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_getorder) -

- -*Get orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApiTrading.GetOrdersAsync(/* parameters */); -``` - -```csharp -Task>>> GetOrdersAsync(Category category, string? symbol = default, string? baseAsset = default, string? orderId = default, string? clientOrderId = default, OrderStatus? status = default, OrderFilter? orderFilter = default, SearchDirection? direction = default, int? limit = default, string? cursor = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|| -|_[Optional]_ symbol|The symbol| -|_[Optional]_ baseAsset|| -|_[Optional]_ orderId|Filter by order id| -|_[Optional]_ clientOrderId|Filter by client order id| -|_[Optional]_ status|Filter by status| -|_[Optional]_ orderFilter|Conditional order or active order| -|_[Optional]_ direction|Search direction| -|_[Optional]_ limit|Data quantity per page: Max data value per page is 50, and default value at 20| -|_[Optional]_ cursor|API pass-through| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## PlaceOrderAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_placeorder](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_placeorder) -

- -*Place a new order* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApiTrading.PlaceOrderAsync(/* parameters */); -``` - -```csharp -Task> PlaceOrderAsync(Category category, string symbol, OrderSide side, OrderType type, decimal quantity, TimeInForce timeInForce, decimal? price = default, decimal? basePrice = default, decimal? triggerPrice = default, PositionMode? positionMode = default, TriggerType? triggerType = default, decimal? iv = default, string? clientOrderId = default, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, bool? reduceOnly = default, bool? closeOnTrigger = default, bool? marketMakerProtection = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Type of derivatives product: linear or option.| -|symbol|The symbol| -|side|Order side| -|type|Order type| -|quantity|Quantity| -|timeInForce|Time in force| -|_[Optional]_ price|c| -|_[Optional]_ basePrice|It will be used to compare with the value of triggerPrice, to decide whether your conditional order will be triggered by crossing trigger price from upper side or lower side. Mainly used to identify the expected direction of the current conditional order.| -|_[Optional]_ triggerPrice|Trigger price. If you're expecting the price to rise to trigger your conditional order, make sure triggerPrice more max(market price, basePrice) else, triggerPrice less min (market price, basePrice)| -|_[Optional]_ positionMode|Position mode| -|_[Optional]_ triggerType|Trigger price type: Market price/Mark price| -|_[Optional]_ iv|Implied volatility, for options only; parameters are passed according to the real value; for example, for 10%, 0.1 is passed| -|_[Optional]_ clientOrderId|Client order id| -|_[Optional]_ takeProfitPrice|Take profit price, only take effect upon opening the position| -|_[Optional]_ stopLossPrice|Stop loss price, only take effect upon opening the position| -|_[Optional]_ takeProfitTriggerType|Take profit trigger price type, default: LastPrice| -|_[Optional]_ stopLossTriggerType|Stop loss trigger price type, default: LastPrice| -|_[Optional]_ reduceOnly|True means your position can only reduce in size if this order is triggered| -|_[Optional]_ closeOnTrigger|For a closing order. It can only reduce your position, not increase it. If the account has insufficient available balance when the closing order is triggered, then other active orders of similar contracts will be cancelled or reduced. It can be used to ensure your stop loss reduces your position regardless of current available margin.| -|_[Optional]_ marketMakerProtection|Market maker protection, "true" means this order is a market maker protection order.| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## ReplaceOrderAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_replaceorder](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-dv_replaceorder) -

- -*Change an exising order. Either orderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApiTrading.ReplaceOrderAsync(/* parameters */); -``` - -```csharp -Task> ReplaceOrderAsync(Category category, string symbol, string? orderId = default, string? clientOrderId = default, OrderFilter? orderFilter = default, decimal? iv = default, decimal? triggerPrice = default, decimal? quantity = default, decimal? price = default, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, TriggerType? triggerType = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Type of derivatives product: linear or option.| -|symbol|The symbol| -|_[Optional]_ orderId|Order ID. Required if not passing orderLinkId| -|_[Optional]_ clientOrderId|Client order id| -|_[Optional]_ orderFilter|Conditional order or active order| -|_[Optional]_ iv|Implied volatility, for options only; parameters are passed according to the real value; for example, for 10%, 0.1 is passed| -|_[Optional]_ triggerPrice|Trigger price| -|_[Optional]_ quantity|Quantity| -|_[Optional]_ price|Quantity| -|_[Optional]_ takeProfitPrice|Take profit price, only take effect upon opening the position| -|_[Optional]_ stopLossPrice|Stop loss price, only take effect upon opening the position| -|_[Optional]_ takeProfitTriggerType|Take profit trigger price type, default: LastPrice| -|_[Optional]_ stopLossTriggerType|Stop loss trigger price type, default: LastPrice>| -|_[Optional]_ triggerType|Trigger price type: Market price/Mark price| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/DerivativesApi/UnifiedMarginApi/IBybitSocketClientUnifiedMarginApi.md b/docs/ClientInfo/DerivativesApi/UnifiedMarginApi/IBybitSocketClientUnifiedMarginApi.md deleted file mode 100644 index 6c25b8e4..00000000 --- a/docs/ClientInfo/DerivativesApi/UnifiedMarginApi/IBybitSocketClientUnifiedMarginApi.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -title: IBybitSocketClientUnifiedMarginApi -has_children: true -parent: IBybitSocketClientDerivativesApi\UnifiedMarginApi -grand_parent: Socket API documentation ---- -*[generated documentation]* -`BybitSocketClient > DerivativesApi\UnifiedMarginApi > UnifiedMarginApi` -*Bybit Unified margin streams* - - -*** - -## SubscribeToBalanceUpdatesAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websocketwallet](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websocketwallet) -

- -*Subscribe to user balance updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApi.SubscribeToBalanceUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToBalanceUpdatesAsync(Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToGreeksUpdatesAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-greeksoption](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-greeksoption) -

- -*Subscribe to greeks update* - -```csharp -var client = new BybitSocketClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApi.SubscribeToGreeksUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToGreeksUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToOrderUpdatesAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websocketorder](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websocketorder) -

- -*Subscribe to user order updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApi.SubscribeToOrderUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToOrderUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToPositionUpdatesAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websocketposition](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websocketposition) -

- -*Subscribe to user position updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApi.SubscribeToPositionUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToPositionUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToUserTradeUpdatesAsync - -[https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websocketexecution](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websocketexecution) -

- -*Subscribe to user trade updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.DerivativesApi\UnifiedMarginApi.UnifiedMarginApi.SubscribeToUserTradeUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToUserTradeUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

diff --git a/docs/ClientInfo/GeneralApi/IBybitRestClientGeneralApi.md b/docs/ClientInfo/GeneralApi/IBybitRestClientGeneralApi.md deleted file mode 100644 index 350ad58b..00000000 --- a/docs/ClientInfo/GeneralApi/IBybitRestClientGeneralApi.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: IBybitRestClientGeneralApi -has_children: true -parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > GeneralApi` -*Bybit general API endpoints* - -*** -*Endpoints related to asset transfer* -**[IBybitRestClientGeneralApiTransfer](IBybitRestClientGeneralApiTransfer.html) Transfer { get; }** -*** -*Endpoint related to withrawing/depositing* -**[IBybitRestClientGeneralApiWithdrawDeposit](IBybitRestClientGeneralApiWithdrawDeposit.html) WithdrawDeposit { get; }** diff --git a/docs/ClientInfo/GeneralApi/IBybitRestClientGeneralApiTransfer.md b/docs/ClientInfo/GeneralApi/IBybitRestClientGeneralApiTransfer.md deleted file mode 100644 index fc591b79..00000000 --- a/docs/ClientInfo/GeneralApi/IBybitRestClientGeneralApiTransfer.md +++ /dev/null @@ -1,279 +0,0 @@ ---- -title: IBybitRestClientGeneralApiTransfer -has_children: false -parent: IBybitRestClientGeneralApi -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > GeneralApi > Transfer` -*Bybit asset transfer endpoints* - - -*** - -## CreateInternalTransferAsync - -[https://bybit-exchange.github.io/docs/account_asset/#t-createinternaltransfer](https://bybit-exchange.github.io/docs/account_asset/#t-createinternaltransfer) -

- -*Create a new transfer from one account type to the other* - -```csharp -var client = new BybitRestClient(); -var result = await client.GeneralApi.Transfer.CreateInternalTransferAsync(/* parameters */); -``` - -```csharp -Task> CreateInternalTransferAsync(string transferId, string asset, decimal quantity, AccountType fromAccountType, AccountType toAccountType, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|transferId|A generated UUID, should be unique| -|asset|The asset to transfer| -|quantity|Quantity to transfer| -|fromAccountType|From account| -|toAccountType|To account| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## CreateSubAccountTransferAsync - -[https://bybit-exchange.github.io/docs/account_asset/#t-createsubaccounttransfer](https://bybit-exchange.github.io/docs/account_asset/#t-createsubaccounttransfer) -

- -*Create a new transfer for a subaccount* - -```csharp -var client = new BybitRestClient(); -var result = await client.GeneralApi.Transfer.CreateSubAccountTransferAsync(/* parameters */); -``` - -```csharp -Task> CreateSubAccountTransferAsync(string transferId, string asset, decimal quantity, string subAccountId, TransferType type, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|transferId|A generated UUID, should be unique| -|asset|The asset to transfer| -|quantity|Quantity to transfer| -|subAccountId|The sub account id| -|type|The type of the transfer| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## EnableSubaccountsUniversalTransferAsync - -[https://bybit-exchange.github.io/docs/account_asset/#t-enableuniversaltransfer](https://bybit-exchange.github.io/docs/account_asset/#t-enableuniversaltransfer) -

- -*Enable universal transfers between sub accounts* - -```csharp -var client = new BybitRestClient(); -var result = await client.GeneralApi.Transfer.EnableSubaccountsUniversalTransferAsync(); -``` - -```csharp -Task EnableSubaccountsUniversalTransferAsync(IEnumerable? subaccountIds = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ subaccountIds|Sub account ids to enable| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetAssetBalanceAsync - -[https://bybit-exchange.github.io/docs/account_asset/v3/#t-queryaccountcoinbalance](https://bybit-exchange.github.io/docs/account_asset/v3/#t-queryaccountcoinbalance) -

- -*Coin balance for an account type including Earn* - -```csharp -var client = new BybitRestClient(); -var result = await client.GeneralApi.Transfer.GetAssetBalanceAsync(/* parameters */); -``` - -```csharp -Task> GetAssetBalanceAsync(AccountType accountType, string asset, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|accountType|Account type| -|asset|Asset| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetSubAccountsAsync - -[https://bybit-exchange.github.io/docs/account_asset/#t-querysubaccountlist](https://bybit-exchange.github.io/docs/account_asset/#t-querysubaccountlist) -

- -*Get a list of subaccount ids* - -```csharp -var client = new BybitRestClient(); -var result = await client.GeneralApi.Transfer.GetSubAccountsAsync(); -``` - -```csharp -Task> GetSubAccountsAsync(long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetSubAccountTransferHistoryAsync - -[https://bybit-exchange.github.io/docs/account_asset/#t-querysubaccounttransferlist](https://bybit-exchange.github.io/docs/account_asset/#t-querysubaccounttransferlist) -

- -*Get history of sub account transfers* - -```csharp -var client = new BybitRestClient(); -var result = await client.GeneralApi.Transfer.GetSubAccountTransferHistoryAsync(); -``` - -```csharp -Task>>> GetSubAccountTransferHistoryAsync(string? transferId = default, string? asset = default, TransferStatus? status = default, DateTime? startTime = default, DateTime? endTime = default, SearchDirection? direction = default, int? limit = default, string? cursor = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ transferId|Filter by transfer id| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ status|Filter by status| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ direction|Filter by direction| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ cursor|Page cursor| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetTransferHistoryAsync - -[https://bybit-exchange.github.io/docs/account_asset/#t-querytransferlist](https://bybit-exchange.github.io/docs/account_asset/#t-querytransferlist) -

- -*Get history of transfers* - -```csharp -var client = new BybitRestClient(); -var result = await client.GeneralApi.Transfer.GetTransferHistoryAsync(); -``` - -```csharp -Task>>> GetTransferHistoryAsync(string? transferId = default, string? asset = default, TransferStatus? status = default, DateTime? startTime = default, DateTime? endTime = default, SearchDirection? direction = default, int? limit = default, string? cursor = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ transferId|Filter by transfer id| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ status|Filter by status| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ direction|Filter by direction| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ cursor|Page cursor| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetUniversalTransferHistoryAsync - -[https://bybit-exchange.github.io/docs/account_asset/#t-queryuniversetransferlist](https://bybit-exchange.github.io/docs/account_asset/#t-queryuniversetransferlist) -

- -*Get history of universal account transfers* - -```csharp -var client = new BybitRestClient(); -var result = await client.GeneralApi.Transfer.GetUniversalTransferHistoryAsync(); -``` - -```csharp -Task>>> GetUniversalTransferHistoryAsync(string? transferId = default, string? asset = default, TransferStatus? status = default, DateTime? startTime = default, DateTime? endTime = default, SearchDirection? direction = default, int? limit = default, string? cursor = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ transferId|Filter by transfer id| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ status|Filter by status| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ direction|Filter by direction| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ cursor|Page cursor| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## UniversalTransferAsync - -[https://bybit-exchange.github.io/docs/account_asset/#t-createuniversaltransfer](https://bybit-exchange.github.io/docs/account_asset/#t-createuniversaltransfer) -

- -*Create a new universal transfer* - -```csharp -var client = new BybitRestClient(); -var result = await client.GeneralApi.Transfer.UniversalTransferAsync(/* parameters */); -``` - -```csharp -Task> UniversalTransferAsync(string transferId, string asset, decimal quantity, string fromMemberId, string toMemberId, AccountType fromAccountType, AccountType toAccountType, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|transferId|Unique id| -|asset|Asset| -|quantity|Quantity| -|fromMemberId|From id| -|toMemberId|To id| -|fromAccountType|From type| -|toAccountType|To type| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/GeneralApi/IBybitRestClientGeneralApiWithdrawDeposit.md b/docs/ClientInfo/GeneralApi/IBybitRestClientGeneralApiWithdrawDeposit.md deleted file mode 100644 index 3ad648c0..00000000 --- a/docs/ClientInfo/GeneralApi/IBybitRestClientGeneralApiWithdrawDeposit.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -title: IBybitRestClientGeneralApiWithdrawDeposit -has_children: false -parent: IBybitRestClientGeneralApi -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > GeneralApi > WithdrawDeposit` -*Bybit withdrawal and deposit endpoints* - - -*** - -## CancelWithdrawalAsync - -[https://bybit-exchange.github.io/docs/account_asset/#t-cancel_withdraw](https://bybit-exchange.github.io/docs/account_asset/#t-cancel_withdraw) -

- -*Cancel withdrawal* - -```csharp -var client = new BybitRestClient(); -var result = await client.GeneralApi.WithdrawDeposit.CancelWithdrawalAsync(/* parameters */); -``` - -```csharp -Task CancelWithdrawalAsync(string withdrawalId, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|withdrawalId|Id to cancel| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetAccountInfoAsync - -[https://bybit-exchange.github.io/docs/account_asset/#t-asset_info_query](https://bybit-exchange.github.io/docs/account_asset/#t-asset_info_query) -

- -*Get account info* - -```csharp -var client = new BybitRestClient(); -var result = await client.GeneralApi.WithdrawDeposit.GetAccountInfoAsync(); -``` - -```csharp -Task>> GetAccountInfoAsync(string? asset = default, string? accountType = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|Filter asset| -|_[Optional]_ accountType|Filter account type| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetAssetInfoAsync - -[https://bybit-exchange.github.io/docs/account_asset/#t-coin_info_query](https://bybit-exchange.github.io/docs/account_asset/#t-coin_info_query) -

- -*Get asset information regarding withdrawal/deposits* - -```csharp -var client = new BybitRestClient(); -var result = await client.GeneralApi.WithdrawDeposit.GetAssetInfoAsync(); -``` - -```csharp -Task>> GetAssetInfoAsync(string? asset = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetDepositAddressesAsync - -[https://bybit-exchange.github.io/docs/account_asset/#t-deposit_addr_info](https://bybit-exchange.github.io/docs/account_asset/#t-deposit_addr_info) -

- -*Get deposit addresses for an asset* - -```csharp -var client = new BybitRestClient(); -var result = await client.GeneralApi.WithdrawDeposit.GetDepositAddressesAsync(/* parameters */); -``` - -```csharp -Task> GetDepositAddressesAsync(string asset, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|asset|The asset to get addresses for| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetDepositHistoryAsync - -[https://bybit-exchange.github.io/docs/account_asset/#t-depositsrecordquery](https://bybit-exchange.github.io/docs/account_asset/#t-depositsrecordquery) -

- -*Get deposit history* - -```csharp -var client = new BybitRestClient(); -var result = await client.GeneralApi.WithdrawDeposit.GetDepositHistoryAsync(); -``` - -```csharp -Task>>> GetDepositHistoryAsync(string? asset = default, DateTime? startTime = default, DateTime? endTime = default, SearchDirection? direction = default, int? limit = default, string? cursor = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ direction|Filter by direction| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ cursor|Page cursor| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetSupportedDepositMethodsAsync - -[https://bybit-exchange.github.io/docs/account_asset/#t-allowdepositlist](https://bybit-exchange.github.io/docs/account_asset/#t-allowdepositlist) -

- -*Get deposit information* - -```csharp -var client = new BybitRestClient(); -var result = await client.GeneralApi.WithdrawDeposit.GetSupportedDepositMethodsAsync(); -``` - -```csharp -Task>> GetSupportedDepositMethodsAsync(string? asset = default, string? network = default, int? page = default, int? pageSize = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ network|Filter by network| -|_[Optional]_ page|Page number| -|_[Optional]_ pageSize|Page size| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetWithdrawalHistoryAsync - -[https://bybit-exchange.github.io/docs/account_asset/#t-withdrawrecordquery](https://bybit-exchange.github.io/docs/account_asset/#t-withdrawrecordquery) -

- -*Get withdrawal history* - -```csharp -var client = new BybitRestClient(); -var result = await client.GeneralApi.WithdrawDeposit.GetWithdrawalHistoryAsync(); -``` - -```csharp -Task>>> GetWithdrawalHistoryAsync(string? withdrawalId = default, string? asset = default, DateTime? startTime = default, DateTime? endTime = default, SearchDirection? direction = default, int? limit = default, string? cursor = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ withdrawalId|Filter by withdrawal id| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ direction|Filter by direction| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ cursor|Page cursor| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## WithdrawAsync - -[https://bybit-exchange.github.io/docs/account_asset/#t-withdraw_info](https://bybit-exchange.github.io/docs/account_asset/#t-withdraw_info) -

- -*Create a withdrawal request* - -```csharp -var client = new BybitRestClient(); -var result = await client.GeneralApi.WithdrawDeposit.WithdrawAsync(/* parameters */); -``` - -```csharp -Task> WithdrawAsync(string asset, string network, string address, decimal quantity, string? tag = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|asset|Asset to withdraw| -|network|Network to use| -|address|Address to withdraw to, should be whitelisted| -|quantity|Quantity to withdraw| -|_[Optional]_ tag|Tag| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/IBybitRestClient.md b/docs/ClientInfo/IBybitRestClient.md deleted file mode 100644 index fcd2521b..00000000 --- a/docs/ClientInfo/IBybitRestClient.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Rest API documentation -has_children: true ---- -*[generated documentation]* -### BybitRestClient -*Client for accessing the Bybit Rest API.* - -*** -*Copy trading API endpoints* -**[IBybitRestClientCopyTradingApi](CopyTradingApi/IBybitRestClientCopyTradingApi.html) CopyTradingApi { get; }** -*** -*Derivatives API endpoints* -**[IBybitRestClientDerivativesApi](DerivativesApi/IBybitRestClientDerivativesApi.html) DerivativesApi { get; }** -*** -*General API endpoints* -**[IBybitRestClientGeneralApi](GeneralApi/IBybitRestClientGeneralApi.html) GeneralApi { get; }** -*** -*Inverse futures API endpoints* -**[IBybitRestClientInverseFuturesApi](InverseFuturesApi/IBybitRestClientInverseFuturesApi.html) InverseFuturesApi { get; }** -*** -*Inverse perpetual API endpoints* -**[IBybitRestClientInversePerpetualApi](InversePerpetualApi/IBybitRestClientInversePerpetualApi.html) InversePerpetualApi { get; }** -*** -*Set the API credentials for this client. All Api clients in this client will use the new credentials, regardless of earlier set options.* -**void SetApiCredentials(ApiCredentials credentials);** -*** -*Spot API endpoints (v1)* -**[IBybitRestClientSpotApiV1](IBybitRestClientSpotApiV1.html) SpotApiV1 { get; }** -*** -*Spot API endpoints (v3)* -**[IBybitRestClientSpotApiV3](IBybitRestClientSpotApiV3.html) SpotApiV3 { get; }** -*** -*USD perpetual API endpoints* -**[IBybitRestClientUsdPerpetualApi](UsdPerpetualApi/IBybitRestClientUsdPerpetualApi.html) UsdPerpetualApi { get; }** -*** -*V5 API endpoints* -**V5.IBybitRestClientApi V5Api { get; }** diff --git a/docs/ClientInfo/IBybitSocketClient.md b/docs/ClientInfo/IBybitSocketClient.md deleted file mode 100644 index 29337686..00000000 --- a/docs/ClientInfo/IBybitSocketClient.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: Socket API documentation -has_children: true ---- -*[generated documentation]* -### BybitSocketClient -*Client for accessing the bybit websocket API* - -*** -*Contract private streams* -**[IBybitSocketClientContractApi](ContractApi/IBybitSocketClientContractApi.html) ContractApi { get; }** -*** -*Copy trading streams* -**[IBybitSocketClientCopyTradingApi](CopyTradingApi/IBybitSocketClientCopyTradingApi.html) CopyTradingApi { get; }** -*** -*Derivatives public streams* -**[IBybitSocketClientDerivativesPublicApi](DerivativesPublicApi/IBybitSocketClientDerivativesPublicApi.html) DerivativesApi { get; }** -*** -*Inverse perpetual streams* -**[IBybitSocketClientInversePerpetualApi](InversePerpetualApi/IBybitSocketClientInversePerpetualApi.html) InversePerpetualApi { get; }** -*** -*Set the API credentials for this client. All Api clients in this client will use the new credentials, regardless of earlier set options.* -**void SetApiCredentials(ApiCredentials credentials);** -*** -*Spot streams v1* -**[IBybitSocketClientSpotApiV1](IBybitSocketClientSpotApiV1.html) SpotV1Api { get; }** -*** -*Spot streams v2* -**[IBybitSocketClientSpotApiV2](IBybitSocketClientSpotApiV2.html) SpotV2Api { get; }** -*** -*Spot streams v3* -**[IBybitSocketClientSpotApiV3](IBybitSocketClientSpotApiV3.html) SpotV3Api { get; }** -*** -*Unified margin private streams* -**[IBybitSocketClientUnifiedMarginApi](UnifiedMarginApi/IBybitSocketClientUnifiedMarginApi.html) UnifiedMarginApi { get; }** -*** -*USD perpetual streams* -**[IBybitSocketClientUsdPerpetualApi](UsdPerpetualApi/IBybitSocketClientUsdPerpetualApi.html) UsdPerpetualApi { get; }** -*** -*V5 Inverse contract streams* -**[IBybitSocketClientInverseApi](InverseApi/IBybitSocketClientInverseApi.html) V5InverseApi { get; }** -*** -*V5 Linear streams* -**[IBybitSocketClientLinearApi](LinearApi/IBybitSocketClientLinearApi.html) V5LinearApi { get; }** -*** -*V5 Option streams* -**[IBybitSocketClientOptionApi](OptionApi/IBybitSocketClientOptionApi.html) V5OptionsApi { get; }** -*** -*V5 Private streams* -**[IBybitSocketClientPrivateApi](PrivateApi/IBybitSocketClientPrivateApi.html) V5PrivateApi { get; }** -*** -*V5 Spot streams* -**[IBybitSocketClientSpotApi](SpotApi/IBybitSocketClientSpotApi.html) V5SpotApi { get; }** diff --git a/docs/ClientInfo/InverseFuturesApi/IBybitRestClientInverseFuturesApi.md b/docs/ClientInfo/InverseFuturesApi/IBybitRestClientInverseFuturesApi.md deleted file mode 100644 index 4f5ef848..00000000 --- a/docs/ClientInfo/InverseFuturesApi/IBybitRestClientInverseFuturesApi.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: IBybitRestClientInverseFuturesApi -has_children: true -parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > InverseFuturesApi` -*[DEPRECATED, WILL STOP WORKING ON 16/30 OCTOBER, USE V5 API INSTEAD] Bybit inverse futures API endpoints* - -*** -*Endpoints related to account settings, info or actions* -**[IBybitRestClientInverseFuturesApiAccount](IBybitRestClientInverseFuturesApiAccount.html) Account { get; }** -*** -*Endpoints related to retrieving market and system data* -**[IBybitRestClientInverseFuturesApiExchangeData](IBybitRestClientInverseFuturesApiExchangeData.html) ExchangeData { get; }** -*** -*Endpoints related to orders and trades* -**[IBybitRestClientInverseFuturesApiTrading](IBybitRestClientInverseFuturesApiTrading.html) Trading { get; }** diff --git a/docs/ClientInfo/InverseFuturesApi/IBybitRestClientInverseFuturesApiAccount.md b/docs/ClientInfo/InverseFuturesApi/IBybitRestClientInverseFuturesApiAccount.md deleted file mode 100644 index 57baf5de..00000000 --- a/docs/ClientInfo/InverseFuturesApi/IBybitRestClientInverseFuturesApiAccount.md +++ /dev/null @@ -1,429 +0,0 @@ ---- -title: IBybitRestClientInverseFuturesApiAccount -has_children: false -parent: IBybitRestClientInverseFuturesApi -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > InverseFuturesApi > Account` -*[DEPRECATED, WILL STOP WORKING ON 30 OCTOBER, USE V5 API INSTEAD] Bybit account endpoints. Account endpoints include balance info, withdraw/deposit info and requesting and account settings* - - -*** - -## ChangeMarginAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-changemargin](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-changemargin) -

- -*Change margin* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Account.ChangeMarginAsync(/* parameters */); -``` - -```csharp -Task> ChangeMarginAsync(string symbol, PositionMode mode, decimal margin, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|mode|The position mode| -|margin|The margin| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetApiKeyInfoAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-key](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-key) -

- -*Get Api key info* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Account.GetApiKeyInfoAsync(); -``` - -```csharp -Task>> GetApiKeyInfoAsync(long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetAssetExchangeHistoryAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-assetexchangerecords](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-assetexchangerecords) -

- -*Get asset exchange history* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Account.GetAssetExchangeHistoryAsync(); -``` - -```csharp -Task>> GetAssetExchangeHistoryAsync(long? fromId = default, SearchDirection? direction = default, int? limit = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ fromId|Filter by id| -|_[Optional]_ direction|Filter by direction| -|_[Optional]_ limit|Max records| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetBalancesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-wallet](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-wallet) -

- -*Get wallet balances* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Account.GetBalancesAsync(); -``` - -```csharp -Task>> GetBalancesAsync(string? asset = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetPositionAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-myposition](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-myposition) -

- -*Get user positions for a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Account.GetPositionAsync(/* parameters */); -``` - -```csharp -Task>> GetPositionAsync(string symbol, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|Filter by symbol| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetPositionsAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-myposition](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-myposition) -

- -*Get user positions* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Account.GetPositionsAsync(); -``` - -```csharp -Task>> GetPositionsAsync(long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetProfitAndLossHistoryAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-closedprofitandloss](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-closedprofitandloss) -

- -*Get user's profit and loss records* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Account.GetProfitAndLossHistoryAsync(/* parameters */); -``` - -```csharp -Task>>> GetProfitAndLossHistoryAsync(string symbol, DateTime? startTime = default, DateTime? endTime = default, TradeType? type = default, int? page = default, int? pageSize = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to get records for| -|_[Optional]_ startTime|Filter by startTime| -|_[Optional]_ endTime|Filter by endTime| -|_[Optional]_ type|Filter by type| -|_[Optional]_ page|Page| -|_[Optional]_ pageSize|Page size| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetRiskLimitAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-getrisklimit](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-getrisklimit) -

- -*Get position risk limit* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Account.GetRiskLimitAsync(); -``` - -```csharp -Task>> GetRiskLimitAsync(string? symbol = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ symbol|The symbol| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetWalletFundHistoryAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-walletrecords](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-walletrecords) -

- -*Get wallet fund endpoints* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Account.GetWalletFundHistoryAsync(); -``` - -```csharp -Task>> GetWalletFundHistoryAsync(string? asset = default, DateTime? startTime = default, DateTime? endTime = default, WalletFundType? type = default, int? pageSize = default, int? page = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ type|Filter by type| -|_[Optional]_ pageSize|Page size| -|_[Optional]_ page|Page| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetWithdrawalHistoryAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-withdrawrecords](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-withdrawrecords) -

- -*Get withdrawal history* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Account.GetWithdrawalHistoryAsync(); -``` - -```csharp -Task>> GetWithdrawalHistoryAsync(string? asset = default, DateTime? startTime = default, DateTime? endTime = default, WithdrawStatus? status = default, int? pageSize = default, int? page = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ status|Filter by status| -|_[Optional]_ pageSize|Page size| -|_[Optional]_ page|Page| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetFullPartialPositionModeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-switchmode](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-switchmode) -

- -*Switch between full or partial Stop loss/Take profit mode* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Account.SetFullPartialPositionModeAsync(/* parameters */); -``` - -```csharp -Task> SetFullPartialPositionModeAsync(string symbol, StopLossTakeProfitMode mode, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|mode|New mode| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetIsolatedPositionModeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-marginswitch](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-marginswitch) -

- -*Switch between cross and isolated mode.* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Account.SetIsolatedPositionModeAsync(/* parameters */); -``` - -```csharp -Task SetIsolatedPositionModeAsync(string symbol, bool isIsolated, decimal buyLeverage, decimal sellLeverage, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|isIsolated|Is isolated| -|buyLeverage|Buy leverage| -|sellLeverage|Sell leverage| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetLeverageAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-setleverage](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-setleverage) -

- -*Set leerage* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Account.SetLeverageAsync(/* parameters */); -``` - -```csharp -Task> SetLeverageAsync(string symbol, decimal buyLeverage, decimal sellLeverage, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|buyLeverage|Buy leverage| -|sellLeverage|Sell leverage| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetPositionModeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-switchpositionmode](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-switchpositionmode) -

- -*Switch beteen onway and hedge position mode.* -*If you are in One-Way Mode, you can only open one position on Buy or Sell side;* -*If you are in Hedge Mode, you can open both Buy and Sell side positions simultaneously.* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Account.SetPositionModeAsync(/* parameters */); -``` - -```csharp -Task SetPositionModeAsync(string symbol, string asset, bool hedgeMode, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|Symbol. Required if not passing coin| -|asset|Currency alias. Required if not passing symbol| -|hedgeMode|Hedgemode| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetRiskLimitAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-risklimit](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-risklimit) -

- -*Set position risk* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Account.SetRiskLimitAsync(/* parameters */); -``` - -```csharp -Task> SetRiskLimitAsync(string symbol, long riskId, PositionMode? mode = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|riskId|The risk id to set| -|_[Optional]_ mode|Position mode| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/InverseFuturesApi/IBybitRestClientInverseFuturesApiExchangeData.md b/docs/ClientInfo/InverseFuturesApi/IBybitRestClientInverseFuturesApiExchangeData.md deleted file mode 100644 index d201c6f2..00000000 --- a/docs/ClientInfo/InverseFuturesApi/IBybitRestClientInverseFuturesApiExchangeData.md +++ /dev/null @@ -1,323 +0,0 @@ ---- -title: IBybitRestClientInverseFuturesApiExchangeData -has_children: false -parent: IBybitRestClientInverseFuturesApi -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > InverseFuturesApi > ExchangeData` -*[DEPRECATED, WILL STOP WORKING ON 16 OCTOBER, USE V5 API INSTEAD] Bybit exchange data endpoints. Exchange data includes market data (tickers, order books, etc) and system status.* - - -*** - -## GetAnnouncementsAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-announcement](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-announcement) -

- -*The API announcements for the last 30 days* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.ExchangeData.GetAnnouncementsAsync(); -``` - -```csharp -Task>> GetAnnouncementsAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetIndexPriceKlinesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-queryindexpricekline](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-queryindexpricekline) -

- -*Get index price klines* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.ExchangeData.GetIndexPriceKlinesAsync(/* parameters */); -``` - -```csharp -Task>> GetIndexPriceKlinesAsync(string symbol, KlineInterval interval, DateTime from, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|Symbol of the klines| -|interval|Interval of the kline data| -|from|Start time of the data| -|_[Optional]_ limit|Max amount of candles| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetKlinesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-querykline](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-querykline) -

- -*Get price klines* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.ExchangeData.GetKlinesAsync(/* parameters */); -``` - -```csharp -Task>> GetKlinesAsync(string symbol, KlineInterval interval, DateTime from, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|Symbol of the klines| -|interval|Interval of the kline data| -|from|Start time of the data| -|_[Optional]_ limit|Max amount of candles| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetLongShortRatioAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-marketaccountratio](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-marketaccountratio) -

- -*Get long/short ratio* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.ExchangeData.GetLongShortRatioAsync(/* parameters */); -``` - -```csharp -Task>> GetLongShortRatioAsync(string symbol, DataPeriod period, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|period|The data period| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetMarkPriceKlinesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-markpricekline](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-markpricekline) -

- -*Get mark price klines* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.ExchangeData.GetMarkPriceKlinesAsync(/* parameters */); -``` - -```csharp -Task>> GetMarkPriceKlinesAsync(string symbol, KlineInterval interval, DateTime from, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|Symbol of the klines| -|interval|Interval of the kline data| -|from|Start time of the data| -|_[Optional]_ limit|Max amount of candles| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOpenInterestAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-marketopeninterest](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-marketopeninterest) -

- -*Gets the total amount of unsettled contracts. In other words, the total number of contracts held in open positions.* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.ExchangeData.GetOpenInterestAsync(/* parameters */); -``` - -```csharp -Task>> GetOpenInterestAsync(string symbol, DataPeriod period, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|period|The period of data| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOrderBookAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-orderbook](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-orderbook) -

- -*Get the current order book for a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.ExchangeData.GetOrderBookAsync(/* parameters */); -``` - -```csharp -Task>> GetOrderBookAsync(string symbol, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetRecentBigTradesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-marketbigdeal](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-marketbigdeal) -

- -*Obtain filled orders worth more than 500,000 USD within the last 24h.* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.ExchangeData.GetRecentBigTradesAsync(/* parameters */); -``` - -```csharp -Task>> GetRecentBigTradesAsync(string symbol, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ limit|The max amount of results| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetServerTimeAsync - -[https://bybit-exchange.github.io/docs/inverse/#t-servertime](https://bybit-exchange.github.io/docs/inverse/#t-servertime) -

- -*Get the server time* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.ExchangeData.GetServerTimeAsync(); -``` - -```csharp -Task> GetServerTimeAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetSymbolsAsync - -[https://bybit-exchange.github.io/docs/futuresV2/futuresV2/inverse_futures/#t-querysymbol](https://bybit-exchange.github.io/docs/futuresV2/futuresV2/inverse_futures/#t-querysymbol) -

- -*Get all supported symbols* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.ExchangeData.GetSymbolsAsync(); -``` - -```csharp -Task>> GetSymbolsAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetTickerAsync - -[https://bybit-exchange.github.io/docs/futuresV2/futuresV2/inverse_futures/#t-latestsymbolinfo](https://bybit-exchange.github.io/docs/futuresV2/futuresV2/inverse_futures/#t-latestsymbolinfo) -

- -*The ticker info for a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.ExchangeData.GetTickerAsync(); -``` - -```csharp -Task>> GetTickerAsync(string? symbol = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ symbol|The symbol| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetTradeHistoryAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-publictradingrecords](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-publictradingrecords) -

- -*Get public trade history* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.ExchangeData.GetTradeHistoryAsync(/* parameters */); -``` - -```csharp -Task>> GetTradeHistoryAsync(string symbol, long? fromId = default, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ fromId|Filter by records after this id| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/InverseFuturesApi/IBybitRestClientInverseFuturesApiTrading.md b/docs/ClientInfo/InverseFuturesApi/IBybitRestClientInverseFuturesApiTrading.md deleted file mode 100644 index 89d6f420..00000000 --- a/docs/ClientInfo/InverseFuturesApi/IBybitRestClientInverseFuturesApiTrading.md +++ /dev/null @@ -1,500 +0,0 @@ ---- -title: IBybitRestClientInverseFuturesApiTrading -has_children: false -parent: IBybitRestClientInverseFuturesApi -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > InverseFuturesApi > Trading` -*[DEPRECATED, WILL STOP WORKING ON 30 OCTOBER, USE V5 API INSTEAD] Bybit trading endpoints, placing and managing orders.* - - -*** - -## CancelAllConditionalOrdersAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-cancelallcond](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-cancelallcond) -

- -*Cancel all active conditional orders for a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Trading.CancelAllConditionalOrdersAsync(/* parameters */); -``` - -```csharp -Task>> CancelAllConditionalOrdersAsync(string symbol, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## CancelAllOrdersAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-cancelallactive](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-cancelallactive) -

- -*Cancel all active orders for a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Trading.CancelAllOrdersAsync(/* parameters */); -``` - -```csharp -Task>> CancelAllOrdersAsync(string symbol, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## CancelConditionalOrderAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-cancelcond](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-cancelcond) -

- -*Cancel a conditional order, either stopOrderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Trading.CancelConditionalOrderAsync(/* parameters */); -``` - -```csharp -Task> CancelConditionalOrderAsync(string symbol, string? stopOrderId = default, string? clientOrderId = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ stopOrderId|The id of the conditional order to cancel| -|_[Optional]_ clientOrderId|The client order id of the conditional order to cancel| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## CancelOrderAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-cancelactive](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-cancelactive) -

- -*Cancel an order, either orderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Trading.CancelOrderAsync(/* parameters */); -``` - -```csharp -Task> CancelOrderAsync(string symbol, string? orderId = default, string? clientOrderId = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ orderId|The id of the order to cancel| -|_[Optional]_ clientOrderId|The client order id of the conditional order to cancel| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetConditionalOrdersAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-getcond](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-getcond) -

- -*Get a list of conditional orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Trading.GetConditionalOrdersAsync(/* parameters */); -``` - -```csharp -Task>>> GetConditionalOrdersAsync(string symbol, StopOrderStatus? status = default, SearchDirection? direction = default, int? limit = default, string? cursor = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ status|Filter by status| -|_[Optional]_ direction|Filter by direction| -|_[Optional]_ limit|Max number of results| -|_[Optional]_ cursor|Page cursor| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOpenConditionalOrderRealTimeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-querycond](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-querycond) -

- -*Get conditional order information. Either stopOrderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Trading.GetOpenConditionalOrderRealTimeAsync(/* parameters */); -``` - -```csharp -Task> GetOpenConditionalOrderRealTimeAsync(string symbol, string? stopOrderId = default, string? clientOrderId = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ stopOrderId|The order id| -|_[Optional]_ clientOrderId|The client order id| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOpenConditionalOrdersRealTimeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-querycond](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-querycond) -

- -*Get order information for up to 10 conditional orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Trading.GetOpenConditionalOrdersRealTimeAsync(/* parameters */); -``` - -```csharp -Task>> GetOpenConditionalOrdersRealTimeAsync(string symbol, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOpenOrderRealTimeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-queryactive](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-queryactive) -

- -*Get order information. Either orderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Trading.GetOpenOrderRealTimeAsync(/* parameters */); -``` - -```csharp -Task> GetOpenOrderRealTimeAsync(string symbol, string? orderId = default, string? clientOrderId = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ orderId|| -|_[Optional]_ clientOrderId|| -|_[Optional]_ receiveWindow|| -|_[Optional]_ ct|| - -

- -*** - -## GetOpenOrdersRealTimeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-queryactive](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-queryactive) -

- -*Get order information for up to 500 orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Trading.GetOpenOrdersRealTimeAsync(/* parameters */); -``` - -```csharp -Task>> GetOpenOrdersRealTimeAsync(string symbol, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOrdersAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-getactive](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-getactive) -

- -*Get orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Trading.GetOrdersAsync(/* parameters */); -``` - -```csharp -Task>>> GetOrdersAsync(string symbol, OrderStatus? status = default, SearchDirection? direction = default, int? limit = default, string? cursor = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ status|Filter by status| -|_[Optional]_ direction|Filter by direction| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ cursor|Page cursor| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetUserTradesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-usertraderecords](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-usertraderecords) -

- -*Get executed user trades* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Trading.GetUserTradesAsync(/* parameters */); -``` - -```csharp -Task>> GetUserTradesAsync(string symbol, string? orderId = default, DateTime? startTime = default, int? page = default, int? pageSize = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ orderId|Filter by order id| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ page|Page| -|_[Optional]_ pageSize|Page size| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## ModifyConditionalOrderAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-replacecond](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-replacecond) -

- -*Change an exising order. Either stopOrderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Trading.ModifyConditionalOrderAsync(/* parameters */); -``` - -```csharp -Task> ModifyConditionalOrderAsync(string symbol, string? stopOrderId = default, string? clientOrderId = default, decimal? newPrice = default, decimal? newTriggerPrice = default, decimal? newQuantity = default, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ stopOrderId|Stop order id| -|_[Optional]_ clientOrderId|Client order id| -|_[Optional]_ newPrice|New price to set| -|_[Optional]_ newTriggerPrice|New trigger price to set| -|_[Optional]_ newQuantity|New quantity to set| -|_[Optional]_ takeProfitPrice|New take profit price| -|_[Optional]_ stopLossPrice|New stop loss price| -|_[Optional]_ takeProfitTriggerType|New take profit trigger type| -|_[Optional]_ stopLossTriggerType|New stop loss profit price| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## ModifyOrderAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-replaceactive](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-replaceactive) -

- -*Change an exising order. Either orderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Trading.ModifyOrderAsync(/* parameters */); -``` - -```csharp -Task> ModifyOrderAsync(string symbol, string? orderId = default, string? clientOrderId = default, decimal? newPrice = default, decimal? newQuantity = default, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ orderId|Stop order id| -|_[Optional]_ clientOrderId|Client order id| -|_[Optional]_ newPrice|New price to set| -|_[Optional]_ newQuantity|New quantity to set| -|_[Optional]_ takeProfitPrice|New take profit price| -|_[Optional]_ stopLossPrice|New stop loss price| -|_[Optional]_ takeProfitTriggerType|New take profit trigger type| -|_[Optional]_ stopLossTriggerType|New stop loss profit price| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## PlaceConditionalOrderAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-placecond](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-placecond) -

- -*Place a new conditional order* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Trading.PlaceConditionalOrderAsync(/* parameters */); -``` - -```csharp -Task> PlaceConditionalOrderAsync(string symbol, OrderSide side, OrderType type, PositionMode positionMode, decimal quantity, decimal basePrice, decimal triggerPrice, TimeInForce timeInForce, decimal? price = default, TriggerType? triggerType = default, bool? closeOnTrigger = default, string? clientOrderId = default, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|side|Order side| -|type|Order type| -|positionMode|Position mode| -|quantity|Quantity| -|basePrice|It will be used to compare with the value of trigger price, to decide whether your conditional order will be triggered by crossing trigger price from upper side or lower side. Mainly used to identify the expected direction of the current conditional order.| -|triggerPrice|Trigger price| -|timeInForce|Time in force| -|_[Optional]_ price|Price| -|_[Optional]_ triggerType|Trigger type| -|_[Optional]_ closeOnTrigger|For a closing order. It can only reduce your position, not increase it. If the account has insufficient available balance when the closing order is triggered, then other active orders of similar contracts will be cancelled or reduced. It can be used to ensure your stop loss reduces your position regardless of current available margin.| -|_[Optional]_ clientOrderId|Client order id| -|_[Optional]_ takeProfitPrice|Take profit price, only take effect upon opening the position| -|_[Optional]_ stopLossPrice|Stop loss price, only take effect upon opening the position| -|_[Optional]_ takeProfitTriggerType|Take profit trigger price type, default: LastPrice| -|_[Optional]_ stopLossTriggerType|Stop loss trigger price type, default: LastPrice| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## PlaceOrderAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-placeactive](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-placeactive) -

- -*Place a new order* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Trading.PlaceOrderAsync(/* parameters */); -``` - -```csharp -Task> PlaceOrderAsync(string symbol, OrderSide side, OrderType type, PositionMode positionMode, decimal quantity, TimeInForce timeInForce, decimal? price = default, bool? closeOnTrigger = default, string? clientOrderId = default, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, bool? reduceOnly = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|side|Order side| -|type|Order type| -|positionMode|Position mode| -|quantity|Quantity| -|timeInForce|Time in force| -|_[Optional]_ price|Price| -|_[Optional]_ closeOnTrigger|For a closing order. It can only reduce your position, not increase it. If the account has insufficient available balance when the closing order is triggered, then other active orders of similar contracts will be cancelled or reduced. It can be used to ensure your stop loss reduces your position regardless of current available margin.| -|_[Optional]_ clientOrderId|Client order id| -|_[Optional]_ takeProfitPrice|Take profit price, only take effect upon opening the position| -|_[Optional]_ stopLossPrice|Stop loss price, only take effect upon opening the position| -|_[Optional]_ takeProfitTriggerType|Take profit trigger price type, default: LastPrice| -|_[Optional]_ stopLossTriggerType|Stop loss trigger price type, default: LastPrice| -|_[Optional]_ reduceOnly|True means your position can only reduce in size if this order is triggered| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetTradingStopAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-tradingstop](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-tradingstop) -

- -*Set take profit, stop loss, and trailing stop for your open position* - -```csharp -var client = new BybitRestClient(); -var result = await client.InverseFuturesApi.Trading.SetTradingStopAsync(/* parameters */); -``` - -```csharp -Task> SetTradingStopAsync(string symbol, PositionMode positionMode, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, decimal? trailingStopPrice = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, decimal? trailingStopTriggerPrice = default, decimal? takeProfitQuantity = default, decimal? stopLossQuantity = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|positionMode|The position mode| -|_[Optional]_ takeProfitPrice|The new take profit price. Setting it to null will not change the value, setting it to 0 will remove the current TakeProfit| -|_[Optional]_ stopLossPrice|The new stop loss price. Setting it to null will not change the value, setting it to 0 will remove the current StopLoss| -|_[Optional]_ trailingStopPrice|Setting it to null will not change the value, setting it to 0 will remove the current TrailingStop| -|_[Optional]_ takeProfitTriggerType|Take profit trigger type, defaults to LastPrice| -|_[Optional]_ stopLossTriggerType|Stop loss trigger type, defaults to LastPrice| -|_[Optional]_ trailingStopTriggerPrice|Trailing stop trigger price. Trailing stops are triggered only when the price reaches the specified price. Trailing stops are triggered immediately by default.| -|_[Optional]_ takeProfitQuantity|Take profit quantity when in Partial mode| -|_[Optional]_ stopLossQuantity|Stop loss quantity when in Partial mode| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/InversePerpetualApi/IBybitRestClientInversePerpetualApi.md b/docs/ClientInfo/InversePerpetualApi/IBybitRestClientInversePerpetualApi.md deleted file mode 100644 index 6cc06f17..00000000 --- a/docs/ClientInfo/InversePerpetualApi/IBybitRestClientInversePerpetualApi.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: IBybitRestClientInversePerpetualApi -has_children: true -parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > InversePerpetualApi` -*[DEPRECATED, WILL STOP WORKING ON 16/30 OCTOBER, USE V5 API INSTEAD] Bybit inverse perpetual API endpoints* - -*** -*Endpoints related to account settings, info or actions* -**[IBybitRestClientInversePerpetualApiAccount](IBybitRestClientInversePerpetualApiAccount.html) Account { get; }** -*** -*Endpoints related to retrieving market and system data* -**[IBybitRestClientInversePerpetualApiExchangeData](IBybitRestClientInversePerpetualApiExchangeData.html) ExchangeData { get; }** -*** -*Endpoints related to orders and trades* -**[IBybitRestClientInversePerpetualApiTrading](IBybitRestClientInversePerpetualApiTrading.html) Trading { get; }** diff --git a/docs/ClientInfo/InversePerpetualApi/IBybitRestClientInversePerpetualApiAccount.md b/docs/ClientInfo/InversePerpetualApi/IBybitRestClientInversePerpetualApiAccount.md deleted file mode 100644 index f65d2045..00000000 --- a/docs/ClientInfo/InversePerpetualApi/IBybitRestClientInversePerpetualApiAccount.md +++ /dev/null @@ -1,450 +0,0 @@ ---- -title: IBybitRestClientInversePerpetualApiAccount -has_children: false -parent: IBybitRestClientInversePerpetualApi -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > InversePerpetualApi > Account` -*[DEPRECATED, WILL STOP WORKING ON 30 OCTOBER, USE V5 API INSTEAD] Bybit account endpoints. Account endpoints include balance info, withdraw/deposit info and requesting and account settings* - - -*** - -## ChangeMarginAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-changemargin](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-changemargin) -

- -*Change margin* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Account.ChangeMarginAsync(/* parameters */); -``` - -```csharp -Task> ChangeMarginAsync(string symbol, decimal margin, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|margin|The margin| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetApiKeyInfoAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-key](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-key) -

- -*Get Api key info* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Account.GetApiKeyInfoAsync(); -``` - -```csharp -Task>> GetApiKeyInfoAsync(long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetAssetExchangeHistoryAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-assetexchangerecords](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-assetexchangerecords) -

- -*Get asset exchange history* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Account.GetAssetExchangeHistoryAsync(); -``` - -```csharp -Task>> GetAssetExchangeHistoryAsync(long? fromId = default, SearchDirection? direction = default, int? limit = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ fromId|Filter by id| -|_[Optional]_ direction|Filter by direction| -|_[Optional]_ limit|Max records| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetBalancesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-balance](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-balance) -

- -*Get wallet balances* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Account.GetBalancesAsync(); -``` - -```csharp -Task>> GetBalancesAsync(string? asset = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetLastUserFundingFeeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-mylastfundingfee](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-mylastfundingfee) -

- -*Get user last funding fee* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Account.GetLastUserFundingFeeAsync(/* parameters */); -``` - -```csharp -Task> GetLastUserFundingFeeAsync(string symbol, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetPositionAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-myposition](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-myposition) -

- -*Get user position for a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Account.GetPositionAsync(/* parameters */); -``` - -```csharp -Task> GetPositionAsync(string symbol, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|Symbol to retrieve position for| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetPositionsAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-myposition](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-myposition) -

- -*Get user positions* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Account.GetPositionsAsync(); -``` - -```csharp -Task>> GetPositionsAsync(long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetPredictedUserFundingFeeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-predictedfunding](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-predictedfunding) -

- -*Get predicted next funding rate* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Account.GetPredictedUserFundingFeeAsync(/* parameters */); -``` - -```csharp -Task> GetPredictedUserFundingFeeAsync(string symbol, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetProfitAndLossHistoryAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-closedprofitandloss](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-closedprofitandloss) -

- -*Get user's profit and loss records* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Account.GetProfitAndLossHistoryAsync(/* parameters */); -``` - -```csharp -Task>>> GetProfitAndLossHistoryAsync(string symbol, DateTime? startTime = default, DateTime? endTime = default, TradeType? type = default, int? page = default, int? pageSize = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to get records for| -|_[Optional]_ startTime|Filter by startTime| -|_[Optional]_ endTime|Filter by endTime| -|_[Optional]_ type|Filter by type| -|_[Optional]_ page|Page| -|_[Optional]_ pageSize|Page size| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetRiskLimitAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-getrisklimit](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-getrisklimit) -

- -*Get position risk limit* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Account.GetRiskLimitAsync(); -``` - -```csharp -Task>> GetRiskLimitAsync(string? symbol = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ symbol|The symbol| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetWalletFundHistoryAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-walletrecords](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-walletrecords) -

- -*Get wallet fund endpoints* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Account.GetWalletFundHistoryAsync(); -``` - -```csharp -Task>> GetWalletFundHistoryAsync(string? asset = default, DateTime? startTime = default, DateTime? endTime = default, WalletFundType? type = default, int? pageSize = default, int? page = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ type|Filter by type| -|_[Optional]_ pageSize|Page size| -|_[Optional]_ page|Page| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetWithdrawalHistoryAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-withdrawrecords](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-withdrawrecords) -

- -*Get withdrawal history* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Account.GetWithdrawalHistoryAsync(); -``` - -```csharp -Task>> GetWithdrawalHistoryAsync(string? asset = default, DateTime? startTime = default, DateTime? endTime = default, WithdrawStatus? status = default, int? pageSize = default, int? page = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ status|Filter by status| -|_[Optional]_ pageSize|Page size| -|_[Optional]_ page|Page| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetFullPartialPositionModeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-switchmode](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-switchmode) -

- -*Switch between full or partial Stop loss/Take profit mode* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Account.SetFullPartialPositionModeAsync(/* parameters */); -``` - -```csharp -Task> SetFullPartialPositionModeAsync(string symbol, StopLossTakeProfitMode mode, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|mode|New mode| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetIsolatedPositionModeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-marginswitch](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-marginswitch) -

- -*Switch between cross and isolated mode.* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Account.SetIsolatedPositionModeAsync(/* parameters */); -``` - -```csharp -Task SetIsolatedPositionModeAsync(string symbol, bool isIsolated, decimal buyLeverage, decimal sellLeverage, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|isIsolated|Is isolated| -|buyLeverage|Buy leverage| -|sellLeverage|Sell leverage| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetLeverageAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-setleverage](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-setleverage) -

- -*Set leverage* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Account.SetLeverageAsync(/* parameters */); -``` - -```csharp -Task> SetLeverageAsync(string symbol, decimal leverage, bool? leverageOnly = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|leverage|Leverage, must be greater than 0 and less than the risk limit leverage| -|_[Optional]_ leverageOnly|Use this parameter to set leverage while in cross margin mode. If this field is set to false, when leverage is equal to 0 the position will use cross margin; when leverage is greater than 0 the position will use isolated margin. If this field is set to true, you can set leverage in cross margin with leverage. leverage must be greater than 0.| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetRiskLimitAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-setrisklimit](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-setrisklimit) -

- -*Set position risk* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Account.SetRiskLimitAsync(/* parameters */); -``` - -```csharp -Task> SetRiskLimitAsync(string symbol, long riskId, PositionMode? mode = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|riskId|The risk id to set| -|_[Optional]_ mode|Position mode| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/InversePerpetualApi/IBybitRestClientInversePerpetualApiExchangeData.md b/docs/ClientInfo/InversePerpetualApi/IBybitRestClientInversePerpetualApiExchangeData.md deleted file mode 100644 index 108bb3f0..00000000 --- a/docs/ClientInfo/InversePerpetualApi/IBybitRestClientInversePerpetualApiExchangeData.md +++ /dev/null @@ -1,376 +0,0 @@ ---- -title: IBybitRestClientInversePerpetualApiExchangeData -has_children: false -parent: IBybitRestClientInversePerpetualApi -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > InversePerpetualApi > ExchangeData` -*[DEPRECATED, WILL STOP WORKING ON 16 OCTOBER, USE V5 API INSTEAD] Bybit exchange data endpoints. Exchange data includes market data (tickers, order books, etc) and system status.* - - -*** - -## GetAnnouncementsAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-announcement](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-announcement) -

- -*The API announcements for the last 30 days* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.ExchangeData.GetAnnouncementsAsync(); -``` - -```csharp -Task>> GetAnnouncementsAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetIndexPriceKlinesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-queryindexpricekline](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-queryindexpricekline) -

- -*Get index price klines* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.ExchangeData.GetIndexPriceKlinesAsync(/* parameters */); -``` - -```csharp -Task>> GetIndexPriceKlinesAsync(string symbol, KlineInterval interval, DateTime from, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|Symbol of the klines| -|interval|Interval of the kline data| -|from|Start time of the data| -|_[Optional]_ limit|Max amount of candles| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetKlinesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-querykline](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-querykline) -

- -*Get price klines* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.ExchangeData.GetKlinesAsync(/* parameters */); -``` - -```csharp -Task>> GetKlinesAsync(string symbol, KlineInterval interval, DateTime from, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|Symbol of the klines| -|interval|Interval of the kline data| -|from|Start time of the data| -|_[Optional]_ limit|Max amount of candles| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetLastFundingRateAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-fundingrate](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-fundingrate) -

- -*Get last funding rate* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.ExchangeData.GetLastFundingRateAsync(/* parameters */); -``` - -```csharp -Task> GetLastFundingRateAsync(string symbol, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetLongShortRatioAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-marketaccountratio](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-marketaccountratio) -

- -*Get long/short ratio* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.ExchangeData.GetLongShortRatioAsync(/* parameters */); -``` - -```csharp -Task>> GetLongShortRatioAsync(string symbol, DataPeriod period, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|period|The data period| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetMarkPriceKlinesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-markpricekline](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-markpricekline) -

- -*Get mark price klines* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.ExchangeData.GetMarkPriceKlinesAsync(/* parameters */); -``` - -```csharp -Task>> GetMarkPriceKlinesAsync(string symbol, KlineInterval interval, DateTime from, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|Symbol of the klines| -|interval|Interval of the kline data| -|from|Start time of the data| -|_[Optional]_ limit|Max amount of candles| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOpenInterestAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-marketopeninterest](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-marketopeninterest) -

- -*Gets the total amount of unsettled contracts. In other words, the total number of contracts held in open positions.* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.ExchangeData.GetOpenInterestAsync(/* parameters */); -``` - -```csharp -Task>> GetOpenInterestAsync(string symbol, DataPeriod period, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|period|The period of data| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOrderBookAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-orderbook](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-orderbook) -

- -*Get the current order book for a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.ExchangeData.GetOrderBookAsync(/* parameters */); -``` - -```csharp -Task>> GetOrderBookAsync(string symbol, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetPremiumIndexKlinesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-querypremiumindexkline](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-querypremiumindexkline) -

- -*Get premium index klines* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.ExchangeData.GetPremiumIndexKlinesAsync(/* parameters */); -``` - -```csharp -Task>> GetPremiumIndexKlinesAsync(string symbol, KlineInterval interval, DateTime from, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|Symbol of the klines| -|interval|Interval of the kline data| -|from|Start time of the data| -|_[Optional]_ limit|Max amount of candles| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetRecentBigTradesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-marketbigdeal](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-marketbigdeal) -

- -*Obtain filled orders worth more than 500,000 USD within the last 24h.* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.ExchangeData.GetRecentBigTradesAsync(/* parameters */); -``` - -```csharp -Task>> GetRecentBigTradesAsync(string symbol, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ limit|The max amount of results| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetServerTimeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-servertime](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-servertime) -

- -*Get the server time* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.ExchangeData.GetServerTimeAsync(); -``` - -```csharp -Task> GetServerTimeAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetSymbolsAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-querysymbol](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-querysymbol) -

- -*Get all supported symbols* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.ExchangeData.GetSymbolsAsync(); -``` - -```csharp -Task>> GetSymbolsAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetTickersAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-latestsymbolinfo](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-latestsymbolinfo) -

- -*The ticker info for a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.ExchangeData.GetTickersAsync(); -``` - -```csharp -Task>> GetTickersAsync(string? symbol = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ symbol|The symbol| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetTradeHistoryAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-publictradingrecords](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-publictradingrecords) -

- -*Get public trade history* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.ExchangeData.GetTradeHistoryAsync(/* parameters */); -``` - -```csharp -Task>> GetTradeHistoryAsync(string symbol, long? fromId = default, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ fromId|Filter by records after this id| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/InversePerpetualApi/IBybitRestClientInversePerpetualApiTrading.md b/docs/ClientInfo/InversePerpetualApi/IBybitRestClientInversePerpetualApiTrading.md deleted file mode 100644 index 1a919bf5..00000000 --- a/docs/ClientInfo/InversePerpetualApi/IBybitRestClientInversePerpetualApiTrading.md +++ /dev/null @@ -1,498 +0,0 @@ ---- -title: IBybitRestClientInversePerpetualApiTrading -has_children: false -parent: IBybitRestClientInversePerpetualApi -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > InversePerpetualApi > Trading` -*[DEPRECATED, WILL STOP WORKING ON 30 OCTOBER, USE V5 API INSTEAD] Bybit trading endpoints, placing and managing orders.* - - -*** - -## CancelAllConditionalOrdersAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-cancelallcond](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-cancelallcond) -

- -*Cancel all active conditional orders for a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Trading.CancelAllConditionalOrdersAsync(/* parameters */); -``` - -```csharp -Task>> CancelAllConditionalOrdersAsync(string symbol, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## CancelAllOrdersAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-cancelallactive](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-cancelallactive) -

- -*Cancel all active orders for a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Trading.CancelAllOrdersAsync(/* parameters */); -``` - -```csharp -Task>> CancelAllOrdersAsync(string symbol, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## CancelConditionalOrderAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-cancelcond](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-cancelcond) -

- -*Cancel a conditional order, either stopOrderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Trading.CancelConditionalOrderAsync(/* parameters */); -``` - -```csharp -Task> CancelConditionalOrderAsync(string symbol, string? stopOrderId = default, string? clientOrderId = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ stopOrderId|The id of the conditional order to cancel| -|_[Optional]_ clientOrderId|The client order id of the conditional order to cancel| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## CancelOrderAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-cancelactive](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-cancelactive) -

- -*Cancel an order, either orderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Trading.CancelOrderAsync(/* parameters */); -``` - -```csharp -Task> CancelOrderAsync(string symbol, string? orderId = default, string? clientOrderId = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ orderId|The id of the order to cancel| -|_[Optional]_ clientOrderId|The client order id of the conditional order to cancel| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetConditionalOrdersAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-getcond](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-getcond) -

- -*Get a list of conditional orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Trading.GetConditionalOrdersAsync(/* parameters */); -``` - -```csharp -Task>>> GetConditionalOrdersAsync(string symbol, StopOrderStatus? status = default, SearchDirection? direction = default, int? limit = default, string? cursor = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ status|Filter by status| -|_[Optional]_ direction|Filter by direction| -|_[Optional]_ limit|Max number of results| -|_[Optional]_ cursor|Page cursor| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOpenConditionalOrderRealTimeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-querycond](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-querycond) -

- -*Get conditional order information. Either stopOrderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Trading.GetOpenConditionalOrderRealTimeAsync(/* parameters */); -``` - -```csharp -Task> GetOpenConditionalOrderRealTimeAsync(string symbol, string? stopOrderId = default, string? clientOrderId = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ stopOrderId|The order id| -|_[Optional]_ clientOrderId|The client order id| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOpenConditionalOrdersRealTimeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-querycond](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-querycond) -

- -*Get order information for up to 10 conditional orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Trading.GetOpenConditionalOrdersRealTimeAsync(/* parameters */); -``` - -```csharp -Task>> GetOpenConditionalOrdersRealTimeAsync(string symbol, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOpenOrderRealTimeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-queryactive](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-queryactive) -

- -*Get order information. Either orderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Trading.GetOpenOrderRealTimeAsync(/* parameters */); -``` - -```csharp -Task> GetOpenOrderRealTimeAsync(string symbol, string? orderId = default, string? clientOrderId = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ orderId|| -|_[Optional]_ clientOrderId|| -|_[Optional]_ receiveWindow|| -|_[Optional]_ ct|| - -

- -*** - -## GetOpenOrdersRealTimeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-queryactive](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-queryactive) -

- -*Get order information for up to 500 orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Trading.GetOpenOrdersRealTimeAsync(/* parameters */); -``` - -```csharp -Task>> GetOpenOrdersRealTimeAsync(string symbol, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOrdersAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-getactive](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-getactive) -

- -*Get orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Trading.GetOrdersAsync(/* parameters */); -``` - -```csharp -Task>>> GetOrdersAsync(string symbol, OrderStatus? status = default, SearchDirection? direction = default, int? limit = default, string? cursor = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ status|Filter by status| -|_[Optional]_ direction|Filter by direction| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ cursor|Page cursor| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetUserTradesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-usertraderecords](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-usertraderecords) -

- -*Get executed user trades* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Trading.GetUserTradesAsync(/* parameters */); -``` - -```csharp -Task>> GetUserTradesAsync(string symbol, string? orderId = default, DateTime? startTime = default, int? page = default, int? pageSize = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ orderId|Filter by order id| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ page|Page| -|_[Optional]_ pageSize|Page size| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## ModifyConditionalOrderAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-replacecond](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-replacecond) -

- -*Change an exising order. Either stopOrderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Trading.ModifyConditionalOrderAsync(/* parameters */); -``` - -```csharp -Task> ModifyConditionalOrderAsync(string symbol, string? stopOrderId = default, string? clientOrderId = default, decimal? newPrice = default, decimal? newTriggerPrice = default, decimal? newQuantity = default, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ stopOrderId|Stop order id| -|_[Optional]_ clientOrderId|Client order id| -|_[Optional]_ newPrice|New price to set| -|_[Optional]_ newTriggerPrice|New trigger price to set| -|_[Optional]_ newQuantity|New quantity to set| -|_[Optional]_ takeProfitPrice|New take profit price| -|_[Optional]_ stopLossPrice|New stop loss price| -|_[Optional]_ takeProfitTriggerType|New take profit trigger type| -|_[Optional]_ stopLossTriggerType|New stop loss profit price| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## ModifyOrderAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-replaceactive](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-replaceactive) -

- -*Change an exising order. Either orderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Trading.ModifyOrderAsync(/* parameters */); -``` - -```csharp -Task> ModifyOrderAsync(string symbol, string? orderId = default, string? clientOrderId = default, decimal? newPrice = default, decimal? newQuantity = default, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ orderId|Stop order id| -|_[Optional]_ clientOrderId|Client order id| -|_[Optional]_ newPrice|New price to set| -|_[Optional]_ newQuantity|New quantity to set| -|_[Optional]_ takeProfitPrice|New take profit price| -|_[Optional]_ stopLossPrice|New stop loss price| -|_[Optional]_ takeProfitTriggerType|New take profit trigger type| -|_[Optional]_ stopLossTriggerType|New stop loss profit price| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## PlaceConditionalOrderAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-placecond](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-placecond) -

- -*Place a new conditional order* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Trading.PlaceConditionalOrderAsync(/* parameters */); -``` - -```csharp -Task> PlaceConditionalOrderAsync(string symbol, OrderSide side, OrderType type, PositionMode positionMode, decimal quantity, decimal basePrice, decimal triggerPrice, TimeInForce timeInForce, decimal? price = default, TriggerType? triggerType = default, bool? closeOnTrigger = default, string? clientOrderId = default, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|side|Order side| -|type|Order type| -|positionMode|Position mode| -|quantity|Quantity| -|basePrice|It will be used to compare with the value of trigger price, to decide whether your conditional order will be triggered by crossing trigger price from upper side or lower side. Mainly used to identify the expected direction of the current conditional order.| -|triggerPrice|Trigger price| -|timeInForce|Time in force| -|_[Optional]_ price|Price| -|_[Optional]_ triggerType|Trigger type| -|_[Optional]_ closeOnTrigger|For a closing order. It can only reduce your position, not increase it. If the account has insufficient available balance when the closing order is triggered, then other active orders of similar contracts will be cancelled or reduced. It can be used to ensure your stop loss reduces your position regardless of current available margin.| -|_[Optional]_ clientOrderId|Client order id| -|_[Optional]_ takeProfitPrice|Take profit price, only take effect upon opening the position| -|_[Optional]_ stopLossPrice|Stop loss price, only take effect upon opening the position| -|_[Optional]_ takeProfitTriggerType|Take profit trigger price type, default: LastPrice| -|_[Optional]_ stopLossTriggerType|Stop loss trigger price type, default: LastPrice| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## PlaceOrderAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-placeactive](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-placeactive) -

- -*Place a new order* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Trading.PlaceOrderAsync(/* parameters */); -``` - -```csharp -Task> PlaceOrderAsync(string symbol, OrderSide side, OrderType type, decimal quantity, TimeInForce timeInForce, decimal? price = default, bool? closeOnTrigger = default, string? clientOrderId = default, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, bool? reduceOnly = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|side|Order side| -|type|Order type| -|quantity|Quantity| -|timeInForce|Time in force| -|_[Optional]_ price|Price| -|_[Optional]_ closeOnTrigger|For a closing order. It can only reduce your position, not increase it. If the account has insufficient available balance when the closing order is triggered, then other active orders of similar contracts will be cancelled or reduced. It can be used to ensure your stop loss reduces your position regardless of current available margin.| -|_[Optional]_ clientOrderId|Client order id| -|_[Optional]_ takeProfitPrice|Take profit price, only take effect upon opening the position| -|_[Optional]_ stopLossPrice|Stop loss price, only take effect upon opening the position| -|_[Optional]_ takeProfitTriggerType|Take profit trigger price type, default: LastPrice| -|_[Optional]_ stopLossTriggerType|Stop loss trigger price type, default: LastPrice| -|_[Optional]_ reduceOnly|True means your position can only reduce in size if this order is triggered| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetTradingStopAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-tradingstop](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-tradingstop) -

- -*Set take profit, stop loss, and trailing stop for your open position* - -```csharp -var client = new BybitRestClient(); -var result = await client.InversePerpetualApi.Trading.SetTradingStopAsync(/* parameters */); -``` - -```csharp -Task> SetTradingStopAsync(string symbol, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, decimal? trailingStopPrice = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, decimal? trailingStopTriggerPrice = default, decimal? takeProfitQuantity = default, decimal? stopLossQuantity = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ takeProfitPrice|The new take profit price. Setting it to null will not change the value, setting it to 0 will remove the current TakeProfit| -|_[Optional]_ stopLossPrice|The new stop loss price. Setting it to null will not change the value, setting it to 0 will remove the current StopLoss| -|_[Optional]_ trailingStopPrice|Setting it to null will not change the value, setting it to 0 will remove the current TrailingStop| -|_[Optional]_ takeProfitTriggerType|Take profit trigger type, defaults to LastPrice| -|_[Optional]_ stopLossTriggerType|Stop loss trigger type, defaults to LastPrice| -|_[Optional]_ trailingStopTriggerPrice|Trailing stop trigger price. Trailing stops are triggered only when the price reaches the specified price. Trailing stops are triggered immediately by default.| -|_[Optional]_ takeProfitQuantity|Take profit quantity when in Partial mode| -|_[Optional]_ stopLossQuantity|Stop loss quantity when in Partial mode| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/InversePerpetualApi/IBybitSocketClientInversePerpetualApi.md b/docs/ClientInfo/InversePerpetualApi/IBybitSocketClientInversePerpetualApi.md deleted file mode 100644 index dd37638c..00000000 --- a/docs/ClientInfo/InversePerpetualApi/IBybitSocketClientInversePerpetualApi.md +++ /dev/null @@ -1,611 +0,0 @@ ---- -title: IBybitSocketClientInversePerpetualApi -has_children: true -parent: Socket API documentation ---- -*[generated documentation]* -`BybitSocketClient > InversePerpetualApi` -*[DEPRECATED, WILL STOP WORKING ON 16/30 OCTOBER, USE V5 API INSTEAD] Bybit inverse perpetual streams* - - -*** - -## SubscribeToBalanceUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketwallet](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketwallet) -

- -*Subscribe to user balance updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.InversePerpetualApi.SubscribeToBalanceUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToBalanceUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToInsurancesUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketinsurance](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketinsurance) -

- -*Subscribe to insurance fund updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.InversePerpetualApi.SubscribeToInsurancesUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToInsurancesUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToInsuranceUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketinsurance](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketinsurance) -

- -*Subscribe to insurance fund updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.InversePerpetualApi.SubscribeToInsuranceUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToInsuranceUpdatesAsync(string symbol, Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to receive updates for| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToInsuranceUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketinsurance](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketinsurance) -

- -*Subscribe to insurance fund updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.InversePerpetualApi.SubscribeToInsuranceUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToInsuranceUpdatesAsync(IEnumerable symbols, Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to receive updates for| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToKlinesUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketklinev2](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketklinev2) -

- -*Subscribe to kline (candlestick) updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.InversePerpetualApi.SubscribeToKlinesUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToKlinesUpdatesAsync(KlineInterval interval, Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|interval|The interval of the klines| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToKlineUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketklinev2](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketklinev2) -

- -*Subscribe to kline (candlestick) updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.InversePerpetualApi.SubscribeToKlineUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToKlineUpdatesAsync(string symbol, KlineInterval interval, Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to receive updates for| -|interval|The interval of the klines| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToKlineUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketklinev2](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketklinev2) -

- -*Subscribe to kline (candlestick) updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.InversePerpetualApi.SubscribeToKlineUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToKlineUpdatesAsync(IEnumerable symbols, KlineInterval interval, Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to receive updates for| -|interval|The interval of the klines| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToLiquidationsUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketliquidation](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketliquidation) -

- -*Subscribe to liquidation order updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.InversePerpetualApi.SubscribeToLiquidationsUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToLiquidationsUpdatesAsync(Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToLiquidationUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketliquidation](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketliquidation) -

- -*Subscribe to liquidation order updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.InversePerpetualApi.SubscribeToLiquidationUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToLiquidationUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to receive updates for| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToLiquidationUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketliquidation](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketliquidation) -

- -*Subscribe to liquidation order updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.InversePerpetualApi.SubscribeToLiquidationUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToLiquidationUpdatesAsync(IEnumerable symbols, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to receive updates for| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToOrderBooksUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketorderbook25](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketorderbook25) -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketorderbook200](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketorderbook200) -

- -*Subscribe to orderbook updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.InversePerpetualApi.SubscribeToOrderBooksUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToOrderBooksUpdatesAsync(int limit, Action>> snapshotHandler, Action>> updateHandler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|limit|The amount of rows to receive updates for. Either 25 or 200.| -|snapshotHandler|The event handler for the initial snapshot data| -|updateHandler|The event handler for the update messages| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToOrderBookUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketorderbook25](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketorderbook25) -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketorderbook200](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketorderbook200) -

- -*Subscribe to orderbook updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.InversePerpetualApi.SubscribeToOrderBookUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToOrderBookUpdatesAsync(string symbol, int limit, Action>> snapshotHandler, Action>> updateHandler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to receive updates for| -|limit|The amount of rows to receive updates for. Either 25 or 200.| -|snapshotHandler|The event handler for the initial snapshot data| -|updateHandler|The event handler for the update messages| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToOrderBookUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketorderbook25](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketorderbook25) -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketorderbook200](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketorderbook200) -

- -*Subscribe to orderbook updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.InversePerpetualApi.SubscribeToOrderBookUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToOrderBookUpdatesAsync(IEnumerable symbols, int limit, Action>> snapshotHandler, Action>> updateHandler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to receive updates for| -|limit|The amount of rows to receive updates for. Either 25 or 200.| -|snapshotHandler|The event handler for the initial snapshot data| -|updateHandler|The event handler for the update messages| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToOrderUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketorder](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketorder) -

- -*Subscribe to user order updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.InversePerpetualApi.SubscribeToOrderUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToOrderUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToPositionUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketposition](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketposition) -

- -*Subscribe to user position updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.InversePerpetualApi.SubscribeToPositionUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToPositionUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToStopOrderUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketstoporder](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketstoporder) -

- -*Subscribe to user stop order updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.InversePerpetualApi.SubscribeToStopOrderUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToStopOrderUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToTickersUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketinstrumentinfo](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketinstrumentinfo) -

- -*Subscribe to ticker updates. Note that for a symbol the first update is a snapshot, containing all info. After that only partial updates are given for* -*properties which have changed. If a property in the update is `null` it isn't changed and should be ignored.* - -```csharp -var client = new BybitSocketClient(); -var result = await client.InversePerpetualApi.SubscribeToTickersUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTickersUpdatesAsync(Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToTickerUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketinstrumentinfo](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketinstrumentinfo) -

- -*Subscribe to ticker updates. Note that for a symbol the first update is a snapshot, containing all info. After that only partial updates are given for* -*properties which have changed. If a property in the update is `null` it isn't changed and should be ignored.* - -```csharp -var client = new BybitSocketClient(); -var result = await client.InversePerpetualApi.SubscribeToTickerUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTickerUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to receive updates for| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToTickerUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketinstrumentinfo](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketinstrumentinfo) -

- -*Subscribe to ticker updates. Note that for a symbol the first update is a snapshot, containing all info. After that only partial updates are given for* -*properties which have changed. If a property in the update is `null` it isn't changed and should be ignored.* - -```csharp -var client = new BybitSocketClient(); -var result = await client.InversePerpetualApi.SubscribeToTickerUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTickerUpdatesAsync(IEnumerable symbols, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to receive updates for| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToTradesUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websockettrade](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websockettrade) -

- -*Subscribe to public trade updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.InversePerpetualApi.SubscribeToTradesUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTradesUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToTradeUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websockettrade](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websockettrade) -

- -*Subscribe to public trade updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.InversePerpetualApi.SubscribeToTradeUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTradeUpdatesAsync(string symbol, Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to receive updates for| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToTradeUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websockettrade](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websockettrade) -

- -*Subscribe to public trade updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.InversePerpetualApi.SubscribeToTradeUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTradeUpdatesAsync(IEnumerable symbols, Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to receive updates for| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToUserTradeUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketexecution](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocketexecution) -

- -*Subscribe to user trade updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.InversePerpetualApi.SubscribeToUserTradeUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToUserTradeUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

diff --git a/docs/ClientInfo/SpotApi/IBybitSpotRequestValidable.md b/docs/ClientInfo/SpotApi/IBybitSpotRequestValidable.md deleted file mode 100644 index f0c127a1..00000000 --- a/docs/ClientInfo/SpotApi/IBybitSpotRequestValidable.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: IBybitSpotRequestValidable -has_children: false -parent: IBybitRestClientSpotApi -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > SpotApi > IBybitSpotRequestValidable` -*Base for spot websocket request/response processing* - -*** -*Match response after subscription* -**bool MatchReponse(JToken responseData);** -*** -*Validate response after subscription* -**bool ValidateResponse(JToken responseData, ref bool forcedExit);** diff --git a/docs/ClientInfo/SpotApi/v1/IBybitRestClientSpotApiAccountV1.md b/docs/ClientInfo/SpotApi/v1/IBybitRestClientSpotApiAccountV1.md deleted file mode 100644 index 13bd9297..00000000 --- a/docs/ClientInfo/SpotApi/v1/IBybitRestClientSpotApiAccountV1.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: IBybitRestClientSpotApiAccountV1 -has_children: false -parent: IBybitRestClientSpotApi\v1 -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > SpotApi\v1 > SpotApiAccountV1` -*[DEPRECATED, WILL STOP WORKING ON 30 OCTOBER, USE V5 API INSTEAD] Bybit account endpoints. Account endpoints include balance info, withdraw/deposit info and requesting and account settings* - - -*** - -## GetBalancesAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-balance](https://bybit-exchange.github.io/docs/spot/v1/#t-balance) -

- -*Get wallet balances* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiAccountV1.GetBalancesAsync(); -``` - -```csharp -Task>> GetBalancesAsync(long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetMarginAccountInfoAsync - -

- -*Get margin account info* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiAccountV1.GetMarginAccountInfoAsync(); -``` - -```csharp -Task> GetMarginAccountInfoAsync(long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/SpotApi/v1/IBybitRestClientSpotApiExchangeDataV1.md b/docs/ClientInfo/SpotApi/v1/IBybitRestClientSpotApiExchangeDataV1.md deleted file mode 100644 index 09dcfbcd..00000000 --- a/docs/ClientInfo/SpotApi/v1/IBybitRestClientSpotApiExchangeDataV1.md +++ /dev/null @@ -1,337 +0,0 @@ ---- -title: IBybitRestClientSpotApiExchangeDataV1 -has_children: false -parent: IBybitRestClientSpotApi\v1 -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > SpotApi\v1 > SpotApiExchangeDataV1` -*[DEPRECATED, WILL STOP WORKING ON 16 OCTOBER, USE V5 API INSTEAD] Bybit exchange data endpoints. Exchange data includes market data (tickers, order books, etc) and system status.* - - -*** - -## GetBookPriceAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-bestbidask](https://bybit-exchange.github.io/docs/spot/v1/#t-bestbidask) -

- -*Get the best ask/bid price for a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiExchangeDataV1.GetBookPriceAsync(/* parameters */); -``` - -```csharp -Task> GetBookPriceAsync(string symbol, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetBookPricesAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-bestbidask](https://bybit-exchange.github.io/docs/spot/v1/#t-bestbidask) -

- -*Get the best ask/bid prices for all symbols* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiExchangeDataV1.GetBookPricesAsync(); -``` - -```csharp -Task>> GetBookPricesAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetBorrowInterestAndQuotaAsync - -

- -*Get borrow info* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiExchangeDataV1.GetBorrowInterestAndQuotaAsync(/* parameters */); -``` - -```csharp -Task> GetBorrowInterestAndQuotaAsync(string asset, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|asset|The asset to retrieve info on| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetKlinesAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-querykline](https://bybit-exchange.github.io/docs/spot/v1/#t-querykline) -

- -*Get price klines* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiExchangeDataV1.GetKlinesAsync(/* parameters */); -``` - -```csharp -Task>> GetKlinesAsync(string symbol, KlineInterval interval, DateTime? startTime = default, DateTime? endTime = default, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|Symbol of the klines| -|interval|Interval of the kline data| -|_[Optional]_ startTime|Start time of the data| -|_[Optional]_ endTime|End time of the data| -|_[Optional]_ limit|Max amount of candles| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetMergedOrderBookAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-mergedorderbook](https://bybit-exchange.github.io/docs/spot/v1/#t-mergedorderbook) -

- -*Get merged order book based on the scale* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiExchangeDataV1.GetMergedOrderBookAsync(/* parameters */); -``` - -```csharp -Task> GetMergedOrderBookAsync(string symbol, int? scale = default, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ scale|The scale of the order book. 1 means 1 digit| -|_[Optional]_ limit|The amount of rows| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOrderBookAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-orderbook](https://bybit-exchange.github.io/docs/spot/v1/#t-orderbook) -

- -*Get the current order book for a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiExchangeDataV1.GetOrderBookAsync(/* parameters */); -``` - -```csharp -Task> GetOrderBookAsync(string symbol, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ limit|The number of rows| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetPriceAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-lasttradedprice](https://bybit-exchange.github.io/docs/spot/v1/#t-lasttradedprice) -

- -*Get the last trade price of a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiExchangeDataV1.GetPriceAsync(/* parameters */); -``` - -```csharp -Task> GetPriceAsync(string symbol, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetPricesAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-lasttradedprice](https://bybit-exchange.github.io/docs/spot/v1/#t-lasttradedprice) -

- -*Get the last trade price of all symbols* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiExchangeDataV1.GetPricesAsync(); -``` - -```csharp -Task>> GetPricesAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetServerTimeAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-servertime](https://bybit-exchange.github.io/docs/spot/v1/#t-servertime) -

- -*Get the server time* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiExchangeDataV1.GetServerTimeAsync(); -``` - -```csharp -Task> GetServerTimeAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetSymbolsAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-spot_querysymbol](https://bybit-exchange.github.io/docs/spot/v1/#t-spot_querysymbol) -

- -*Get all supported symbols* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiExchangeDataV1.GetSymbolsAsync(); -``` - -```csharp -Task>> GetSymbolsAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetTickerAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-spot_latestsymbolinfo](https://bybit-exchange.github.io/docs/spot/v1/#t-spot_latestsymbolinfo) -

- -*The ticker info for a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiExchangeDataV1.GetTickerAsync(/* parameters */); -``` - -```csharp -Task> GetTickerAsync(string symbol, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetTickersAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-spot_latestsymbolinfo](https://bybit-exchange.github.io/docs/spot/v1/#t-spot_latestsymbolinfo) -

- -*The ticker info for all symbols* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiExchangeDataV1.GetTickersAsync(); -``` - -```csharp -Task>> GetTickersAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetTradeHistoryAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-publictradingrecords](https://bybit-exchange.github.io/docs/spot/v1/#t-publictradingrecords) -

- -*Get public trade history* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiExchangeDataV1.GetTradeHistoryAsync(/* parameters */); -``` - -```csharp -Task>> GetTradeHistoryAsync(string symbol, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/SpotApi/v1/IBybitRestClientSpotApiTradingV1.md b/docs/ClientInfo/SpotApi/v1/IBybitRestClientSpotApiTradingV1.md deleted file mode 100644 index 7cb74885..00000000 --- a/docs/ClientInfo/SpotApi/v1/IBybitRestClientSpotApiTradingV1.md +++ /dev/null @@ -1,321 +0,0 @@ ---- -title: IBybitRestClientSpotApiTradingV1 -has_children: false -parent: IBybitRestClientSpotApi\v1 -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > SpotApi\v1 > SpotApiTradingV1` -*[DEPRECATED, WILL STOP WORKING ON 30 OCTOBER, USE V5 API INSTEAD] Bybit trading endpoints, placing and managing orders.* - - -*** - -## CancelMultipleOrderAsync - -

- -*Cancel multiple orders based on the provided parameters* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiTradingV1.CancelMultipleOrderAsync(/* parameters */); -``` - -```csharp -Task CancelMultipleOrderAsync(string symbol, OrderSide? side = default, IEnumerable? orderTypes = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to cancel orders on| -|_[Optional]_ side|Only cancel buy or sell orders| -|_[Optional]_ orderTypes|Only cancel orders fitting the order types, default only cancels Limit orders (not LimitMaker orders)| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## CancelOrderAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-cancelactive](https://bybit-exchange.github.io/docs/spot/v1/#t-cancelactive) -

- -*Cancel an active order. Either orderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiTradingV1.CancelOrderAsync(); -``` - -```csharp -Task> CancelOrderAsync(long? orderId = default, string? clientOrderId = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ orderId|The order id| -|_[Optional]_ clientOrderId|The client order id| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetBorrowRecordsAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-queryborrowinginfo](https://bybit-exchange.github.io/docs/spot/v1/#t-queryborrowinginfo) -

- -*Get borrow records* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiTradingV1.GetBorrowRecordsAsync(); -``` - -```csharp -Task>> GetBorrowRecordsAsync(DateTime? startTime = default, DateTime? endTime = default, string? asset = default, BorrowStatus? status = default, int? limit = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ startTime|Filter by borrow time| -|_[Optional]_ endTime|Filter by borrow time| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ status|Filter by status| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOpenOrdersAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-openorders](https://bybit-exchange.github.io/docs/spot/v1/#t-openorders) -

- -*Get open orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiTradingV1.GetOpenOrdersAsync(); -``` - -```csharp -Task>> GetOpenOrdersAsync(string? symbol = default, long? orderId = default, int? limit = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ symbol|The symbol| -|_[Optional]_ orderId|Filter by order id, will only return orders with an orderId smaller than this| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOrderAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-getactive](https://bybit-exchange.github.io/docs/spot/v1/#t-getactive) -

- -*Get order, either orderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiTradingV1.GetOrderAsync(); -``` - -```csharp -Task> GetOrderAsync(long? orderId = default, string? clientOrderId = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ orderId|The id of the order| -|_[Optional]_ clientOrderId|The client order id| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOrdersAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-orderhistory](https://bybit-exchange.github.io/docs/spot/v1/#t-orderhistory) -

- -*Get orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiTradingV1.GetOrdersAsync(); -``` - -```csharp -Task>> GetOrdersAsync(string? symbol = default, long? orderId = default, int? limit = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ symbol|Filter by symbol| -|_[Optional]_ orderId|Filter by order id, will only return orders with an orderId smaller than this| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetRepayRecordsAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-queryrepaymenthistory](https://bybit-exchange.github.io/docs/spot/v1/#t-queryrepaymenthistory) -

- -*Get repayment records* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiTradingV1.GetRepayRecordsAsync(); -``` - -```csharp -Task>> GetRepayRecordsAsync(DateTime? startTime = default, DateTime? endTime = default, string? asset = default, int? limit = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ startTime|Filter by borrow time| -|_[Optional]_ endTime|Filter by borrow time| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetUserTradesAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-tradehistory](https://bybit-exchange.github.io/docs/spot/v1/#t-tradehistory) -

- -*Get user trade history* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiTradingV1.GetUserTradesAsync(); -``` - -```csharp -Task>> GetUserTradesAsync(string? symbol = default, long? fromId = default, long? toId = default, int? limit = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ symbol|Filter by symbol| -|_[Optional]_ fromId|Filter by start id| -|_[Optional]_ toId|Filter by end id| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## PlaceBorrowOrderAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-borrowmarginloan](https://bybit-exchange.github.io/docs/spot/v1/#t-borrowmarginloan) -

- -*Place a new borrow order* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiTradingV1.PlaceBorrowOrderAsync(/* parameters */); -``` - -```csharp -Task> PlaceBorrowOrderAsync(string asset, decimal quantity, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|asset|The asset to borrow| -|quantity|The quantity to borrow| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## PlaceOrderAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-placeactive](https://bybit-exchange.github.io/docs/spot/v1/#t-placeactive) -

- -*Place a new order* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiTradingV1.PlaceOrderAsync(/* parameters */); -``` - -```csharp -Task> PlaceOrderAsync(string symbol, OrderSide side, OrderType type, decimal quantity, decimal? price = default, TimeInForce? timeInForce = default, string? clientOrderId = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|side|Order side| -|type|Order type| -|quantity|Quantity of the order. Note that for market buy orders this is the quantity of quote asset, otherwise it's in base asset| -|_[Optional]_ price|Price| -|_[Optional]_ timeInForce|Time in force| -|_[Optional]_ clientOrderId|Client order id| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## PlaceRepayOrderAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-repaymarginloan](https://bybit-exchange.github.io/docs/spot/v1/#t-repaymarginloan) -

- -*Place a new borrow order* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v1.SpotApiTradingV1.PlaceRepayOrderAsync(/* parameters */); -``` - -```csharp -Task> PlaceRepayOrderAsync(string asset, decimal quantity, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|asset|The asset to repay| -|quantity|The quantity to repay| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/SpotApi/v1/IBybitRestClientSpotApiV1.md b/docs/ClientInfo/SpotApi/v1/IBybitRestClientSpotApiV1.md deleted file mode 100644 index 90add0ce..00000000 --- a/docs/ClientInfo/SpotApi/v1/IBybitRestClientSpotApiV1.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: IBybitRestClientSpotApiV1 -has_children: false -parent: IBybitRestClientSpotApi\v1 -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > SpotApi\v1 > SpotApiV1` -*[DEPRECATED, WILL STOP WORKING ON 16/30 OCTOBER, USE V5 API INSTEAD] Bybit spot API endpoints (v1)* - -*** -*Get the ISpotClient for this client. This is a common interface which allows for some basic operations without knowing any details of the exchange.* -**ISpotClient CommonSpotClient { get; }** -*** -*Endpoints related to account settings, info or actions* -**[IBybitRestClientSpotApiAccountV1](IBybitRestClientSpotApiAccountV1.html) Account { get; }** -*** -*Endpoints related to retrieving market and system data* -**[IBybitRestClientSpotApiExchangeDataV1](IBybitRestClientSpotApiExchangeDataV1.html) ExchangeData { get; }** -*** -*Endpoints related to orders and trades* -**[IBybitRestClientSpotApiTradingV1](IBybitRestClientSpotApiTradingV1.html) Trading { get; }** diff --git a/docs/ClientInfo/SpotApi/v1/IBybitSocketClientSpotApiV1.md b/docs/ClientInfo/SpotApi/v1/IBybitSocketClientSpotApiV1.md deleted file mode 100644 index af82c679..00000000 --- a/docs/ClientInfo/SpotApi/v1/IBybitSocketClientSpotApiV1.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -title: IBybitSocketClientSpotApiV1 -has_children: false -parent: IBybitSocketClientSpotApi\v1 -grand_parent: Socket API documentation ---- -*[generated documentation]* -`BybitSocketClient > SpotApi\v1 > SpotApiV1` -*[DEPRECATED, WILL STOP WORKING ON 16 OCTOBER, USE V5 API INSTEAD] Bybit spot streams* - - -*** - -## SubscribeToKlineUpdatesAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-websocketkline](https://bybit-exchange.github.io/docs/spot/v1/#t-websocketkline) -

- -*Subscribe to kline updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.SpotApi\v1.SpotApiV1.SubscribeToKlineUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToKlineUpdatesAsync(string symbol, KlineInterval interval, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|interval|Interval of the kline data| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToLeverageTokenUpdatesAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-websocketltnetvalue](https://bybit-exchange.github.io/docs/spot/v1/#t-websocketltnetvalue) -

- -*Subscribe to leverage token net value updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.SpotApi\v1.SpotApiV1.SubscribeToLeverageTokenUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToLeverageTokenUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToOrderBookDiffUpdatesAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-websocketdiffdepth](https://bybit-exchange.github.io/docs/spot/v1/#t-websocketdiffdepth) -

- -*Subscribe to diff of order book updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.SpotApi\v1.SpotApiV1.SubscribeToOrderBookDiffUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToOrderBookDiffUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToOrderBookMergedUpdatesAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-websocketmergeddepth](https://bybit-exchange.github.io/docs/spot/v1/#t-websocketmergeddepth) -

- -*Subscribe to aggregated order book updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.SpotApi\v1.SpotApiV1.SubscribeToOrderBookMergedUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToOrderBookMergedUpdatesAsync(string symbol, int dumpScale, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|dumpScale|It refers to the number of decimal places, eg 1 for 50000.5 or 0 for 50000| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToOrderBookUpdatesAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-websocketdepth](https://bybit-exchange.github.io/docs/spot/v1/#t-websocketdepth) -

- -*Subscribe to order book updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.SpotApi\v1.SpotApiV1.SubscribeToOrderBookUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToOrderBookUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToTickerUpdatesAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-websocketrealtimes](https://bybit-exchange.github.io/docs/spot/v1/#t-websocketrealtimes) -

- -*Subscribe to ticker updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.SpotApi\v1.SpotApiV1.SubscribeToTickerUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTickerUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToTradeUpdatesAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-websockettrade](https://bybit-exchange.github.io/docs/spot/v1/#t-websockettrade) -

- -*Subscribe to public trade updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.SpotApi\v1.SpotApiV1.SubscribeToTradeUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTradeUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

diff --git a/docs/ClientInfo/SpotApi/v2/IBybitSocketClientSpotApiV2.md b/docs/ClientInfo/SpotApi/v2/IBybitSocketClientSpotApiV2.md deleted file mode 100644 index 3ded06c0..00000000 --- a/docs/ClientInfo/SpotApi/v2/IBybitSocketClientSpotApiV2.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -title: IBybitSocketClientSpotApiV2 -has_children: false -parent: IBybitSocketClientSpotApi\v2 -grand_parent: Socket API documentation ---- -*[generated documentation]* -`BybitSocketClient > SpotApi\v2 > SpotApiV2` -*[DEPRECATED, WILL STOP WORKING ON 16/30 OCTOBER, USE V5 API INSTEAD] Bybit spot streams* - - -*** - -## SubscribeToAccountUpdatesAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-privatetopics](https://bybit-exchange.github.io/docs/spot/v1/#t-privatetopics) -

- -*Subscribe to account data updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.SpotApi\v2.SpotApiV2.SubscribeToAccountUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToAccountUpdatesAsync(Action> accountUpdateHandler, Action> orderUpdateHandler, Action> stopOrderUpdateHandler, Action> tradeUpdateHandler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|accountUpdateHandler|Account(balance) update handler| -|orderUpdateHandler|Order update handler| -|stopOrderUpdateHandler| SL/TP order update handler| -|tradeUpdateHandler|User trade update handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToBookPriceUpdatesAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-websocketv2bookticker](https://bybit-exchange.github.io/docs/spot/v1/#t-websocketv2bookticker) -

- -*Subscribe to book price updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.SpotApi\v2.SpotApiV2.SubscribeToBookPriceUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToBookPriceUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToKlineUpdatesAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-websocketv2kline](https://bybit-exchange.github.io/docs/spot/v1/#t-websocketv2kline) -

- -*Subscribe to kline updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.SpotApi\v2.SpotApiV2.SubscribeToKlineUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToKlineUpdatesAsync(string symbol, KlineInterval interval, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|interval|Interval of the kline data| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToOrderBookUpdatesAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-websocketv2depth](https://bybit-exchange.github.io/docs/spot/v1/#t-websocketv2depth) -

- -*Subscribe to order book updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.SpotApi\v2.SpotApiV2.SubscribeToOrderBookUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToOrderBookUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToTickerUpdatesAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-websocketv2realtimes](https://bybit-exchange.github.io/docs/spot/v1/#t-websocketv2realtimes) -

- -*Subscribe to ticker updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.SpotApi\v2.SpotApiV2.SubscribeToTickerUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTickerUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToTradeUpdatesAsync - -[https://bybit-exchange.github.io/docs/spot/v1/#t-websocketv2trade](https://bybit-exchange.github.io/docs/spot/v1/#t-websocketv2trade) -

- -*Subscribe to public trade updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.SpotApi\v2.SpotApiV2.SubscribeToTradeUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTradeUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

diff --git a/docs/ClientInfo/SpotApi/v3/IBybitRestClientSpotApiAccountV3.md b/docs/ClientInfo/SpotApi/v3/IBybitRestClientSpotApiAccountV3.md deleted file mode 100644 index f5973d02..00000000 --- a/docs/ClientInfo/SpotApi/v3/IBybitRestClientSpotApiAccountV3.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: IBybitRestClientSpotApiAccountV3 -has_children: false -parent: IBybitRestClientSpotApi\v3 -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > SpotApi\v3 > SpotApiAccountV3` -*Bybit account endpoints. Account endpoints include balance info, withdraw/deposit info and requesting and account settings* - - -*** - -## GetBalancesAsync - -[https://bybit-exchange.github.io/docs/spot/v3/#t-wallet](https://bybit-exchange.github.io/docs/spot/v3/#t-wallet) -

- -*Get wallet balances* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiAccountV3.GetBalancesAsync(); -``` - -```csharp -Task>> GetBalancesAsync(long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetMarginAccountInfoAsync - -

- -*Get margin account info* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiAccountV3.GetMarginAccountInfoAsync(); -``` - -```csharp -Task> GetMarginAccountInfoAsync(long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/SpotApi/v3/IBybitRestClientSpotApiExchangeDataV3.md b/docs/ClientInfo/SpotApi/v3/IBybitRestClientSpotApiExchangeDataV3.md deleted file mode 100644 index 303a97e1..00000000 --- a/docs/ClientInfo/SpotApi/v3/IBybitRestClientSpotApiExchangeDataV3.md +++ /dev/null @@ -1,337 +0,0 @@ ---- -title: IBybitRestClientSpotApiExchangeDataV3 -has_children: false -parent: IBybitRestClientSpotApi\v3 -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > SpotApi\v3 > SpotApiExchangeDataV3` -*Bybit exchange data endpoints. Exchange data includes market data (tickers, order books, etc) and system status.* - - -*** - -## GetBookPriceAsync - -[https://bybit-exchange.github.io/docs/spot/v3/#t-bestbidask](https://bybit-exchange.github.io/docs/spot/v3/#t-bestbidask) -

- -*Get the best ask/bid price for a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiExchangeDataV3.GetBookPriceAsync(/* parameters */); -``` - -```csharp -Task> GetBookPriceAsync(string symbol, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetBookPricesAsync - -[https://bybit-exchange.github.io/docs/spot/v3/#t-bestbidask](https://bybit-exchange.github.io/docs/spot/v3/#t-bestbidask) -

- -*Get the best ask/bid prices for all symbols* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiExchangeDataV3.GetBookPricesAsync(); -``` - -```csharp -Task>> GetBookPricesAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetBorrowInterestAndQuotaAsync - -

- -*Get borrow info* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiExchangeDataV3.GetBorrowInterestAndQuotaAsync(/* parameters */); -``` - -```csharp -Task> GetBorrowInterestAndQuotaAsync(string asset, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|asset|The asset to retrieve info on| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetKlinesAsync - -[https://bybit-exchange.github.io/docs/spot/v3/#t-querykline](https://bybit-exchange.github.io/docs/spot/v3/#t-querykline) -

- -*Get price klines* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiExchangeDataV3.GetKlinesAsync(/* parameters */); -``` - -```csharp -Task>> GetKlinesAsync(string symbol, KlineInterval interval, DateTime? startTime = default, DateTime? endTime = default, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|Symbol of the klines| -|interval|Interval of the kline data| -|_[Optional]_ startTime|Start time of the data| -|_[Optional]_ endTime|End time of the data| -|_[Optional]_ limit|Max amount of candles| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetMergedOrderBookAsync - -[https://bybit-exchange.github.io/docs/spot/v3/#t-mergedorderbook](https://bybit-exchange.github.io/docs/spot/v3/#t-mergedorderbook) -

- -*Get merged order book based on the scale* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiExchangeDataV3.GetMergedOrderBookAsync(/* parameters */); -``` - -```csharp -Task> GetMergedOrderBookAsync(string symbol, int? scale = default, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ scale|The scale of the order book. 1 means 1 digit| -|_[Optional]_ limit|The amount of rows| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOrderBookAsync - -[https://bybit-exchange.github.io/docs/spot/v3/#t-orderbook](https://bybit-exchange.github.io/docs/spot/v3/#t-orderbook) -

- -*Get the current order book for a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiExchangeDataV3.GetOrderBookAsync(/* parameters */); -``` - -```csharp -Task> GetOrderBookAsync(string symbol, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ limit|The number of rows| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetPriceAsync - -[https://bybit-exchange.github.io/docs/spot/v3/#t-lasttradedprice](https://bybit-exchange.github.io/docs/spot/v3/#t-lasttradedprice) -

- -*Get the last trade price of a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiExchangeDataV3.GetPriceAsync(/* parameters */); -``` - -```csharp -Task> GetPriceAsync(string symbol, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetPricesAsync - -[https://bybit-exchange.github.io/docs/spot/v3/#t-lasttradedprice](https://bybit-exchange.github.io/docs/spot/v3/#t-lasttradedprice) -

- -*Get the last trade price of all symbols* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiExchangeDataV3.GetPricesAsync(); -``` - -```csharp -Task>> GetPricesAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetServerTimeAsync - -[https://bybit-exchange.github.io/docs/spot/v3/#t-servertime](https://bybit-exchange.github.io/docs/spot/v3/#t-servertime) -

- -*Get the server time* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiExchangeDataV3.GetServerTimeAsync(); -``` - -```csharp -Task> GetServerTimeAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetSymbolsAsync - -[https://bybit-exchange.github.io/docs/spot/v3/#t-getsymbols](https://bybit-exchange.github.io/docs/spot/v3/#t-getsymbols) -

- -*Get all supported symbols* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiExchangeDataV3.GetSymbolsAsync(); -``` - -```csharp -Task>> GetSymbolsAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetTickerAsync - -[https://bybit-exchange.github.io/docs/spot/v3/#t-spot_latestsymbolinfo](https://bybit-exchange.github.io/docs/spot/v3/#t-spot_latestsymbolinfo) -

- -*The ticker info for a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiExchangeDataV3.GetTickerAsync(/* parameters */); -``` - -```csharp -Task> GetTickerAsync(string symbol, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetTickersAsync - -[https://bybit-exchange.github.io/docs/spot/v3/#t-spot_latestsymbolinfo](https://bybit-exchange.github.io/docs/spot/v3/#t-spot_latestsymbolinfo) -

- -*The ticker info for all symbols* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiExchangeDataV3.GetTickersAsync(); -``` - -```csharp -Task>> GetTickersAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetTradeHistoryAsync - -[https://bybit-exchange.github.io/docs/spot/v3/#t-publictradingrecords](https://bybit-exchange.github.io/docs/spot/v3/#t-publictradingrecords) -

- -*Get public trade history* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiExchangeDataV3.GetTradeHistoryAsync(/* parameters */); -``` - -```csharp -Task>> GetTradeHistoryAsync(string symbol, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/SpotApi/v3/IBybitRestClientSpotApiTradingV3.md b/docs/ClientInfo/SpotApi/v3/IBybitRestClientSpotApiTradingV3.md deleted file mode 100644 index cfc490c7..00000000 --- a/docs/ClientInfo/SpotApi/v3/IBybitRestClientSpotApiTradingV3.md +++ /dev/null @@ -1,326 +0,0 @@ ---- -title: IBybitRestClientSpotApiTradingV3 -has_children: false -parent: IBybitRestClientSpotApi\v3 -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > SpotApi\v3 > SpotApiTradingV3` -*Bybit trading endpoints, placing and managing orders.* - - -*** - -## CancelMultipleOrderAsync - -

- -*Cancel multiple orders based on the provided parameters* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiTradingV3.CancelMultipleOrderAsync(/* parameters */); -``` - -```csharp -Task CancelMultipleOrderAsync(string symbol, OrderSide? side = default, IEnumerable? orderTypes = default, int? orderCategory, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to cancel orders on| -|_[Optional]_ side|Only cancel buy or sell orders| -|_[Optional]_ orderTypes|Only cancel orders fitting the order types, default only cancels Limit orders (not LimitMaker orders)| -|orderCategory| Order category. 0：normal order by default; 1：TP/SL order, Required for TP/SL order. | -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## CancelOrderAsync - -[https://bybit-exchange.github.io/docs/spot/#t-cancelactive](https://bybit-exchange.github.io/docs/spot/#t-cancelactive) -

- -*Cancel an active order. Either orderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiTradingV3.CancelOrderAsync(/* parameters */); -``` - -```csharp -Task> CancelOrderAsync(long? orderId = default, string? clientOrderId = default, int? orderCategory, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ orderId|The order id| -|_[Optional]_ clientOrderId|The client order id| -|orderCategory| Order category. 0：normal order by default; 1：TP/SL order, Required for TP/SL order. | -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetBorrowRecordsAsync - -[https://bybit-exchange.github.io/docs/spot/#t-queryborrowinginfo](https://bybit-exchange.github.io/docs/spot/#t-queryborrowinginfo) -

- -*Get borrow records* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiTradingV3.GetBorrowRecordsAsync(); -``` - -```csharp -Task>> GetBorrowRecordsAsync(DateTime? startTime = default, DateTime? endTime = default, string? asset = default, BorrowStatus? status = default, int? limit = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ startTime|Filter by borrow time| -|_[Optional]_ endTime|Filter by borrow time| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ status|Filter by status| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOpenOrdersAsync - -[https://bybit-exchange.github.io/docs/spot/#t-openorders](https://bybit-exchange.github.io/docs/spot/#t-openorders) -

- -*Get open orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiTradingV3.GetOpenOrdersAsync(/* parameters */); -``` - -```csharp -Task>> GetOpenOrdersAsync(string? symbol = default, long? orderId = default, int? limit = default, int? orderCategory, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ symbol|The symbol| -|_[Optional]_ orderId|Filter by order id, will only return orders with an orderId smaller than this| -|_[Optional]_ limit|Max amount of results| -|orderCategory|Order category. 0：normal order by default; 1：TP/SL order, Required for TP/SL order.| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOrderAsync - -[https://bybit-exchange.github.io/docs/spot/#t-getactive](https://bybit-exchange.github.io/docs/spot/#t-getactive) -

- -*Get order, either orderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiTradingV3.GetOrderAsync(); -``` - -```csharp -Task> GetOrderAsync(long? orderId = default, string? clientOrderId = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ orderId|The id of the order| -|_[Optional]_ clientOrderId|The client order id| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOrdersAsync - -[https://bybit-exchange.github.io/docs/spot/#t-orderhistory](https://bybit-exchange.github.io/docs/spot/#t-orderhistory) -

- -*Get orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiTradingV3.GetOrdersAsync(); -``` - -```csharp -Task>> GetOrdersAsync(string? symbol = default, long? orderId = default, int? limit = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ symbol|Filter by symbol| -|_[Optional]_ orderId|Filter by order id, will only return orders with an orderId smaller than this| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetRepayRecordsAsync - -[https://bybit-exchange.github.io/docs/spot/#t-queryrepaymenthistory](https://bybit-exchange.github.io/docs/spot/#t-queryrepaymenthistory) -

- -*Get repayment records* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiTradingV3.GetRepayRecordsAsync(); -``` - -```csharp -Task>> GetRepayRecordsAsync(DateTime? startTime = default, DateTime? endTime = default, string? asset = default, int? limit = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ startTime|Filter by borrow time| -|_[Optional]_ endTime|Filter by borrow time| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetUserTradesAsync - -[https://bybit-exchange.github.io/docs/spot/#t-tradehistory](https://bybit-exchange.github.io/docs/spot/#t-tradehistory) -

- -*Get user trade history* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiTradingV3.GetUserTradesAsync(); -``` - -```csharp -Task>> GetUserTradesAsync(string? symbol = default, long? fromId = default, long? toId = default, int? limit = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ symbol|Filter by symbol| -|_[Optional]_ fromId|Filter by start id| -|_[Optional]_ toId|Filter by end id| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## PlaceBorrowOrderAsync - -[https://bybit-exchange.github.io/docs/spot/#t-borrowmarginloan](https://bybit-exchange.github.io/docs/spot/#t-borrowmarginloan) -

- -*Place a new borrow order* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiTradingV3.PlaceBorrowOrderAsync(/* parameters */); -``` - -```csharp -Task> PlaceBorrowOrderAsync(string asset, decimal quantity, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|asset|The asset to borrow| -|quantity|The quantity to borrow| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## PlaceOrderAsync - -[https://bybit-exchange.github.io/docs/spot/v3/#t-placeactive](https://bybit-exchange.github.io/docs/spot/v3/#t-placeactive) -

- -*Place a new order* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiTradingV3.PlaceOrderAsync(/* parameters */); -``` - -```csharp -Task> PlaceOrderAsync(string symbol, OrderSide side, OrderType type, decimal quantity, decimal? price = default, TimeInForce? timeInForce = default, string? clientOrderId = default, int orderCategory, decimal? triggerPrice = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|side|Order side| -|type|Order type| -|quantity|Quantity of the order. Note that for market buy orders this is the quantity of quote asset, otherwise it's in base asset| -|_[Optional]_ price|Price| -|_[Optional]_ timeInForce|Time in force| -|_[Optional]_ clientOrderId|Client order id| -|orderCategory| Order category. 0：normal order; 1：TP/SL order | -|_[Optional]_ triggerPrice| Trigger price | -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## PlaceRepayOrderAsync - -[https://bybit-exchange.github.io/docs/spot/#t-repaymarginloan](https://bybit-exchange.github.io/docs/spot/#t-repaymarginloan) -

- -*Place a new borrow order* - -```csharp -var client = new BybitRestClient(); -var result = await client.SpotApi\v3.SpotApiTradingV3.PlaceRepayOrderAsync(/* parameters */); -``` - -```csharp -Task> PlaceRepayOrderAsync(string asset, decimal quantity, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|asset|The asset to repay| -|quantity|The quantity to repay| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/SpotApi/v3/IBybitRestClientSpotApiV3.md b/docs/ClientInfo/SpotApi/v3/IBybitRestClientSpotApiV3.md deleted file mode 100644 index 65bfbb0e..00000000 --- a/docs/ClientInfo/SpotApi/v3/IBybitRestClientSpotApiV3.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: IBybitRestClientSpotApiV3 -has_children: false -parent: IBybitRestClientSpotApi\v3 -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > SpotApi\v3 > SpotApiV3` -*Bybit spot API endpoints (v3)* - -*** -*Get the ISpotClient for this client. This is a common interface which allows for some basic operations without knowing any details of the exchange.* -**ISpotClient CommonSpotClient { get; }** -*** -*Endpoints related to account settings, info or actions* -**[IBybitRestClientSpotApiAccountV3](IBybitRestClientSpotApiAccountV3.html) Account { get; }** -*** -*Endpoints related to retrieving market and system data* -**[IBybitRestClientSpotApiExchangeDataV3](IBybitRestClientSpotApiExchangeDataV3.html) ExchangeData { get; }** -*** -*Endpoints related to orders and trades* -**[IBybitRestClientSpotApiTradingV3](IBybitRestClientSpotApiTradingV3.html) Trading { get; }** diff --git a/docs/ClientInfo/SpotApi/v3/IBybitSocketClientSpotApiV3.md b/docs/ClientInfo/SpotApi/v3/IBybitSocketClientSpotApiV3.md deleted file mode 100644 index 8ab752b0..00000000 --- a/docs/ClientInfo/SpotApi/v3/IBybitSocketClientSpotApiV3.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -title: IBybitSocketClientSpotApiV3 -has_children: false -parent: IBybitSocketClientSpotApi\v3 -grand_parent: Socket API documentation ---- -*[generated documentation]* -`BybitSocketClient > SpotApi\v3 > SpotApiV3` -*Bybit spot streams* - - -*** - -## SubscribeToAccountUpdatesAsync - -[https://bybit-exchange.github.io/docs/spot/#t-privatetopics](https://bybit-exchange.github.io/docs/spot/#t-privatetopics) -

- -*Subscribe to account balances update* - -```csharp -var client = new BybitSocketClient(); -var result = await client.SpotApi\v3.SpotApiV3.SubscribeToAccountUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToAccountUpdatesAsync(Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToBookPriceUpdatesAsync - -[https://bybit-exchange.github.io/docs/spot/#t-websocketv2bookticker](https://bybit-exchange.github.io/docs/spot/#t-websocketv2bookticker) -

- -*Subscribe to book price updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.SpotApi\v3.SpotApiV3.SubscribeToBookPriceUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToBookPriceUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToKlineUpdatesAsync - -[https://bybit-exchange.github.io/docs/spot/#t-websocketv2kline](https://bybit-exchange.github.io/docs/spot/#t-websocketv2kline) -

- -*Subscribe to kline updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.SpotApi\v3.SpotApiV3.SubscribeToKlineUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToKlineUpdatesAsync(string symbol, KlineInterval interval, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|interval|Interval of the kline data| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToOrderBookUpdatesAsync - -[https://bybit-exchange.github.io/docs/spot/v3/#t-websocketdepth](https://bybit-exchange.github.io/docs/spot/v3/#t-websocketdepth) -

- -*Subscribe to order book updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.SpotApi\v3.SpotApiV3.SubscribeToOrderBookUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToOrderBookUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToTickerUpdatesAsync - -[https://bybit-exchange.github.io/docs/spot/#t-websocketv2realtimes](https://bybit-exchange.github.io/docs/spot/#t-websocketv2realtimes) -

- -*Subscribe to ticker updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.SpotApi\v3.SpotApiV3.SubscribeToTickerUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTickerUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToTradeUpdatesAsync - -[https://bybit-exchange.github.io/docs/spot/v3/#t-websockettrade](https://bybit-exchange.github.io/docs/spot/v3/#t-websockettrade) -

- -*Subscribe to public trade updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.SpotApi\v3.SpotApiV3.SubscribeToTradeUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTradeUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToUserOrdersUpdatesAsync - -

- -*Subscribe to orders updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.SpotApi\v3.SpotApiV3.SubscribeToUserOrdersUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToUserOrdersUpdatesAsync(Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToUserStopOrdersUpdatesAsync - -[https://bybit-exchange.github.io/docs/spot/v3/#t-websocketspotstoporder](https://bybit-exchange.github.io/docs/spot/v3/#t-websocketspotstoporder) -

- -*Subscribe to SL/TP orders updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.SpotApi\v3.SpotApiV3.SubscribeToUserStopOrdersUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToUserStopOrdersUpdatesAsync(Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToUserTradesUpdatesAsync - -

- -*Susbcribe to user trade updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.SpotApi\v3.SpotApiV3.SubscribeToUserTradesUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToUserTradesUpdatesAsync(Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

diff --git a/docs/ClientInfo/UsdPerpetualApi/IBybitRestClientUsdPerpetualApi.md b/docs/ClientInfo/UsdPerpetualApi/IBybitRestClientUsdPerpetualApi.md deleted file mode 100644 index ecf6d8d8..00000000 --- a/docs/ClientInfo/UsdPerpetualApi/IBybitRestClientUsdPerpetualApi.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: IBybitRestClientUsdPerpetualApi -has_children: true -parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > UsdPerpetualApi` -*[DEPRECATED, WILL STOP WORKING ON 16/30 OCTOBER, USE V5 API INSTEAD] Bybit USD perpetual API endpoints* - -*** -*Endpoints related to account settings, info or actions* -**[IBybitRestClientUsdPerpetualApiAccount](IBybitRestClientUsdPerpetualApiAccount.html) Account { get; }** -*** -*Endpoints related to retrieving market and system data* -**[IBybitRestClientUsdPerpetualApiExchangeData](IBybitRestClientUsdPerpetualApiExchangeData.html) ExchangeData { get; }** -*** -*Endpoints related to orders and trades* -**[IBybitRestClientUsdPerpetualApiTrading](IBybitRestClientUsdPerpetualApiTrading.html) Trading { get; }** diff --git a/docs/ClientInfo/UsdPerpetualApi/IBybitRestClientUsdPerpetualApiAccount.md b/docs/ClientInfo/UsdPerpetualApi/IBybitRestClientUsdPerpetualApiAccount.md deleted file mode 100644 index bb33e624..00000000 --- a/docs/ClientInfo/UsdPerpetualApi/IBybitRestClientUsdPerpetualApiAccount.md +++ /dev/null @@ -1,510 +0,0 @@ ---- -title: IBybitRestClientUsdPerpetualApiAccount -has_children: false -parent: IBybitRestClientUsdPerpetualApi -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > UsdPerpetualApi > Account` -*[DEPRECATED, WILL STOP WORKING ON 30 OCTOBER, USE V5 API INSTEAD] Bybit account endpoints. Account endpoints include balance info, withdraw/deposit info and requesting and changing account settings* - - -*** - -## AddReduceMarginAsync - -

- -*Add/reduce margin* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Account.AddReduceMarginAsync(/* parameters */); -``` - -```csharp -Task> AddReduceMarginAsync(string symbol, OrderSide side, decimal margin, PositionMode? positionMode = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|side|The side| -|margin|Margin to add (positive) or remove (negative)| -|_[Optional]_ positionMode|Position mode| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetApiKeyInfoAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-key](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-key) -

- -*Get Api key info* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Account.GetApiKeyInfoAsync(); -``` - -```csharp -Task>> GetApiKeyInfoAsync(long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetAssetExchangeHistoryAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-assetexchangerecords](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-assetexchangerecords) -

- -*Get asset exchange history* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Account.GetAssetExchangeHistoryAsync(); -``` - -```csharp -Task>> GetAssetExchangeHistoryAsync(long? fromId = default, SearchDirection? direction = default, int? limit = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ fromId|Filter by id| -|_[Optional]_ direction|Filter by direction| -|_[Optional]_ limit|Max records| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetBalancesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-balance](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-balance) -

- -*Get wallet balances* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Account.GetBalancesAsync(); -``` - -```csharp -Task>> GetBalancesAsync(string? asset = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetPositionAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-myposition](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-myposition) -

- -*Get user positions* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Account.GetPositionAsync(/* parameters */); -``` - -```csharp -Task>> GetPositionAsync(string symbol, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|Filter by symbol| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetPositionsAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-myposition](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-myposition) -

- -*Get user positions* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Account.GetPositionsAsync(); -``` - -```csharp -Task>> GetPositionsAsync(long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetProfitAndLossHistoryAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-closedprofitandloss](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-closedprofitandloss) -

- -*Get user's profit and loss records* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Account.GetProfitAndLossHistoryAsync(/* parameters */); -``` - -```csharp -Task>>> GetProfitAndLossHistoryAsync(string symbol, DateTime? startTime = default, DateTime? endTime = default, TradeType? type = default, int? page = default, int? pageSize = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to get records for| -|_[Optional]_ startTime|Filter by startTime| -|_[Optional]_ endTime|Filter by endTime| -|_[Optional]_ type|Filter by type| -|_[Optional]_ page|Page| -|_[Optional]_ pageSize|Page size| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetRiskLimitAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-getrisklimit](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-getrisklimit) -

- -*Get position risk limit* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Account.GetRiskLimitAsync(/* parameters */); -``` - -```csharp -Task>> GetRiskLimitAsync(string symbol, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetUserLastFundingFeeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-mylastfundingfee](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-mylastfundingfee) -

- -*Get user last funding fee* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Account.GetUserLastFundingFeeAsync(/* parameters */); -``` - -```csharp -Task> GetUserLastFundingFeeAsync(string symbol, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetUserPredictedFundingRateAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-predictedfunding](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-predictedfunding) -

- -*Get predicted next funding rate* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Account.GetUserPredictedFundingRateAsync(/* parameters */); -``` - -```csharp -Task> GetUserPredictedFundingRateAsync(string symbol, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetWalletFundHistoryAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-walletrecords](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-walletrecords) -

- -*Get wallet fund endpoints* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Account.GetWalletFundHistoryAsync(); -``` - -```csharp -Task>> GetWalletFundHistoryAsync(string? asset = default, DateTime? startTime = default, DateTime? endTime = default, WalletFundType? type = default, int? pageSize = default, int? page = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ type|Filter by type| -|_[Optional]_ pageSize|Page size| -|_[Optional]_ page|Page| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetWithdrawalHistoryAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-withdrawrecords](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-withdrawrecords) -

- -*Get withdrawal history* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Account.GetWithdrawalHistoryAsync(); -``` - -```csharp -Task>> GetWithdrawalHistoryAsync(string? asset = default, DateTime? startTime = default, DateTime? endTime = default, WithdrawStatus? status = default, int? pageSize = default, int? page = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ status|Filter by status| -|_[Optional]_ pageSize|Page size| -|_[Optional]_ page|Page| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetAutoAddMarginAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-setautoaddmargin](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-setautoaddmargin) -

- -*Set auto add margin switch* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Account.SetAutoAddMarginAsync(/* parameters */); -``` - -```csharp -Task SetAutoAddMarginAsync(string symbol, OrderSide side, bool autoAddMargin, PositionMode? positionMode = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|Symbol| -|side|Side| -|autoAddMargin|Auto add or not| -|_[Optional]_ positionMode|Position mode| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetFullPartialPositionModeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-switchmode](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-switchmode) -

- -*Switch between full or partial Stop loss/Take profit mode* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Account.SetFullPartialPositionModeAsync(/* parameters */); -``` - -```csharp -Task> SetFullPartialPositionModeAsync(string symbol, StopLossTakeProfitMode mode, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|mode|New mode| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetIsolatedPositionModeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-marginswitch](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-marginswitch) -

- -*Switch Cross/Isolated; must set leverage value when switching from Cross to Isolated* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Account.SetIsolatedPositionModeAsync(/* parameters */); -``` - -```csharp -Task SetIsolatedPositionModeAsync(string symbol, bool isIsolated, decimal buyLeverage, decimal sellLeverage, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|isIsolated|True is Isolated; false is Cross| -|buyLeverage|Buy leverage| -|sellLeverage|Sell leverage| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetLeverageAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-setleverage](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-setleverage) -

- -*Set leverage* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Account.SetLeverageAsync(/* parameters */); -``` - -```csharp -Task SetLeverageAsync(string symbol, decimal buyLeverage, decimal sellLeverage, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|buyLeverage|Buy leverage| -|sellLeverage|Sell leverage| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetPositionModeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-switchpositionmode](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-switchpositionmode) -

- -*Switch position mode. If you are in One-Way Mode, you can only open one position on Buy or Sell side;* -*If you are in Hedge Mode, you can open both Buy and Sell side positions simultaneously.* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Account.SetPositionModeAsync(/* parameters */); -``` - -```csharp -Task SetPositionModeAsync(string symbol, string asset, bool hedgeMode, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|Symbol. Required if not passing coin| -|asset|Currency alias. Required if not passing symbol| -|hedgeMode|True = HedgeMode, False = OneWayMode| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetRiskLimitAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-setrisklimit](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-setrisklimit) -

- -*Set position risk* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Account.SetRiskLimitAsync(/* parameters */); -``` - -```csharp -Task> SetRiskLimitAsync(string symbol, OrderSide side, long riskId, PositionMode? positionMode = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|side|Side| -|riskId|The risk id to set| -|_[Optional]_ positionMode|Position mode| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/UsdPerpetualApi/IBybitRestClientUsdPerpetualApiExchangeData.md b/docs/ClientInfo/UsdPerpetualApi/IBybitRestClientUsdPerpetualApiExchangeData.md deleted file mode 100644 index e7cfa755..00000000 --- a/docs/ClientInfo/UsdPerpetualApi/IBybitRestClientUsdPerpetualApiExchangeData.md +++ /dev/null @@ -1,375 +0,0 @@ ---- -title: IBybitRestClientUsdPerpetualApiExchangeData -has_children: false -parent: IBybitRestClientUsdPerpetualApi -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > UsdPerpetualApi > ExchangeData` -*[DEPRECATED, WILL STOP WORKING ON 16 OCTOBER, USE V5 API INSTEAD] Bybit exchange data endpoints. Exchange data includes market data (tickers, order books, etc) and system status.* - - -*** - -## GetAnnouncementsAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-announcement](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-announcement) -

- -*The API announcements for the last 30 days* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.ExchangeData.GetAnnouncementsAsync(); -``` - -```csharp -Task>> GetAnnouncementsAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetIndexPriceKlinesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-queryindexpricekline](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-queryindexpricekline) -

- -*Get index price klines* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.ExchangeData.GetIndexPriceKlinesAsync(/* parameters */); -``` - -```csharp -Task>> GetIndexPriceKlinesAsync(string symbol, KlineInterval interval, DateTime from, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|Symbol of the klines| -|interval|Interval of the kline data| -|from|Start time of the data| -|_[Optional]_ limit|Max amount of candles| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetKlinesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-querykline](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-querykline) -

- -*Get price klines* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.ExchangeData.GetKlinesAsync(/* parameters */); -``` - -```csharp -Task>> GetKlinesAsync(string symbol, KlineInterval interval, DateTime from, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|Symbol of the klines| -|interval|Interval of the kline data| -|from|Start time of the data| -|_[Optional]_ limit|Max amount of candles| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetLastFundingRateAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-fundingrate](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-fundingrate) -

- -*Get last funding rate* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.ExchangeData.GetLastFundingRateAsync(/* parameters */); -``` - -```csharp -Task> GetLastFundingRateAsync(string symbol, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetLongShortRatioAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-marketaccountratio](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-marketaccountratio) -

- -*Get long/short ratio* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.ExchangeData.GetLongShortRatioAsync(/* parameters */); -``` - -```csharp -Task>> GetLongShortRatioAsync(string symbol, DataPeriod period, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|period|The data period| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetMarkPriceKlinesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-markpricekline](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-markpricekline) -

- -*Get mark price klines* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.ExchangeData.GetMarkPriceKlinesAsync(/* parameters */); -``` - -```csharp -Task>> GetMarkPriceKlinesAsync(string symbol, KlineInterval interval, DateTime from, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|Symbol of the klines| -|interval|Interval of the kline data| -|from|Start time of the data| -|_[Optional]_ limit|Max amount of candles| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOpenInterestAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-marketopeninterest](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-marketopeninterest) -

- -*Gets the total amount of unsettled contracts. In other words, the total number of contracts held in open positions.* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.ExchangeData.GetOpenInterestAsync(/* parameters */); -``` - -```csharp -Task>> GetOpenInterestAsync(string symbol, DataPeriod period, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|period|The period of data| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOrderBookAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-orderbook](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-orderbook) -

- -*Get the current order book for a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.ExchangeData.GetOrderBookAsync(/* parameters */); -``` - -```csharp -Task>> GetOrderBookAsync(string symbol, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetPremiumIndexKlinesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-querypremiumindexkline](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-querypremiumindexkline) -

- -*Get premium index klines* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.ExchangeData.GetPremiumIndexKlinesAsync(/* parameters */); -``` - -```csharp -Task>> GetPremiumIndexKlinesAsync(string symbol, KlineInterval interval, DateTime from, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|Symbol of the klines| -|interval|Interval of the kline data| -|from|Start time of the data| -|_[Optional]_ limit|Max amount of candles| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetRecentBigTradesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-marketbigdeal](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-marketbigdeal) -

- -*Obtain filled orders worth more than 500,000 USD within the last 24h.* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.ExchangeData.GetRecentBigTradesAsync(/* parameters */); -``` - -```csharp -Task>> GetRecentBigTradesAsync(string symbol, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ limit|The max amount of results| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetServerTimeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-servertime](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-servertime) -

- -*Get the server time* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.ExchangeData.GetServerTimeAsync(); -``` - -```csharp -Task> GetServerTimeAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetSymbolsAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-querysymbol](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-querysymbol) -

- -*Get all supported symbols* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.ExchangeData.GetSymbolsAsync(); -``` - -```csharp -Task>> GetSymbolsAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetTickerAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-latestsymbolinfo](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-latestsymbolinfo) -

- -*The ticker info for a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.ExchangeData.GetTickerAsync(); -``` - -```csharp -Task>> GetTickerAsync(string? symbol = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ symbol|The symbol| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetTradeHistoryAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-publictradingrecords](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-publictradingrecords) -

- -*Get public trade history* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.ExchangeData.GetTradeHistoryAsync(/* parameters */); -``` - -```csharp -Task>> GetTradeHistoryAsync(string symbol, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ limit|Max amount of results| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/UsdPerpetualApi/IBybitRestClientUsdPerpetualApiTrading.md b/docs/ClientInfo/UsdPerpetualApi/IBybitRestClientUsdPerpetualApiTrading.md deleted file mode 100644 index f5516148..00000000 --- a/docs/ClientInfo/UsdPerpetualApi/IBybitRestClientUsdPerpetualApiTrading.md +++ /dev/null @@ -1,506 +0,0 @@ ---- -title: IBybitRestClientUsdPerpetualApiTrading -has_children: false -parent: IBybitRestClientUsdPerpetualApi -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > UsdPerpetualApi > Trading` -*[DEPRECATED, WILL STOP WORKING ON 30 OCTOBER, USE V5 API INSTEAD] Bybit trading endpoints, placing and managing orders.* - - -*** - -## CancelAllConditionalOrdersAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-cancelallcond](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-cancelallcond) -

- -*Cancel all active conditional orders for a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Trading.CancelAllConditionalOrdersAsync(/* parameters */); -``` - -```csharp -Task>> CancelAllConditionalOrdersAsync(string symbol, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## CancelAllOrdersAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-cancelallactive](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-cancelallactive) -

- -*Cancel all active orders for a symbol* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Trading.CancelAllOrdersAsync(/* parameters */); -``` - -```csharp -Task>> CancelAllOrdersAsync(string symbol, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## CancelConditionalOrderAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-cancelcond](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-cancelcond) -

- -*Cancel a conditional order, either stopOrderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Trading.CancelConditionalOrderAsync(/* parameters */); -``` - -```csharp -Task> CancelConditionalOrderAsync(string symbol, string? stopOrderId = default, string? clientOrderId = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ stopOrderId|The id of the conditional order to cancel| -|_[Optional]_ clientOrderId|The client order id of the conditional order to cancel| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## CancelOrderAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-cancelactive](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-cancelactive) -

- -*Cancel an order, either orderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Trading.CancelOrderAsync(/* parameters */); -``` - -```csharp -Task> CancelOrderAsync(string symbol, string? orderId = default, string? clientOrderId = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ orderId|The id of the order to cancel| -|_[Optional]_ clientOrderId|The client order id of the conditional order to cancel| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetConditionalOrdersAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-getcond](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-getcond) -

- -*Get a list of conditional orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Trading.GetConditionalOrdersAsync(/* parameters */); -``` - -```csharp -Task>>> GetConditionalOrdersAsync(string symbol, string? stopOrderId = default, string? clientOrderId = default, OrderStatus? status = default, SortOrder? order = default, int? pageSize = default, int? page = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ stopOrderId|Filter by order id| -|_[Optional]_ clientOrderId|Filter by client order id| -|_[Optional]_ status|Filter by status| -|_[Optional]_ order|Result order| -|_[Optional]_ pageSize|Page size| -|_[Optional]_ page|Page| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOpenConditionalOrderRealTimeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-querycond](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-querycond) -

- -*Get conditional order information. Either stopOrderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Trading.GetOpenConditionalOrderRealTimeAsync(/* parameters */); -``` - -```csharp -Task> GetOpenConditionalOrderRealTimeAsync(string symbol, string? stopOrderId = default, string? clientOrderId = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ stopOrderId|The order id| -|_[Optional]_ clientOrderId|The client order id| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOpenConditionalOrdersRealTimeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-querycond](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-querycond) -

- -*Get order information for up to 10 conditional orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Trading.GetOpenConditionalOrdersRealTimeAsync(/* parameters */); -``` - -```csharp -Task>> GetOpenConditionalOrdersRealTimeAsync(string symbol, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOpenOrderRealTimeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-queryactive](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-queryactive) -

- -*Get order information. Either orderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Trading.GetOpenOrderRealTimeAsync(/* parameters */); -``` - -```csharp -Task> GetOpenOrderRealTimeAsync(string symbol, string? orderId = default, string? clientOrderId = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ orderId|| -|_[Optional]_ clientOrderId|| -|_[Optional]_ receiveWindow|| -|_[Optional]_ ct|| - -

- -*** - -## GetOpenOrdersRealTimeAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-queryactive](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-queryactive) -

- -*Get order information for up to 500 orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Trading.GetOpenOrdersRealTimeAsync(/* parameters */); -``` - -```csharp -Task>> GetOpenOrdersRealTimeAsync(string symbol, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOrdersAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-getactive](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-getactive) -

- -*Get orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Trading.GetOrdersAsync(/* parameters */); -``` - -```csharp -Task>>> GetOrdersAsync(string symbol, string? orderId = default, string? clientOrderId = default, OrderStatus? status = default, SortOrder? order = default, int? pageSize = default, int? page = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ orderId|Filter by order id| -|_[Optional]_ clientOrderId|Filter by client order id| -|_[Optional]_ status|Filter by status| -|_[Optional]_ order|The result order| -|_[Optional]_ pageSize|The page size| -|_[Optional]_ page|The page| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetUserTradesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-usertraderecords](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-usertraderecords) -

- -*Get executed user trades* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Trading.GetUserTradesAsync(/* parameters */); -``` - -```csharp -Task>>> GetUserTradesAsync(string symbol, DateTime? startTime = default, DateTime? endTime = default, int? page = default, int? pageSize = default, TradeType? type = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ page|Page| -|_[Optional]_ pageSize|Page size| -|_[Optional]_ type|Filter by type| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## ModifyConditionalOrderAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-replacecond](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-replacecond) -

- -*Change an exising order. Either stopOrderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Trading.ModifyConditionalOrderAsync(/* parameters */); -``` - -```csharp -Task> ModifyConditionalOrderAsync(string symbol, string? stopOrderId = default, string? clientOrderId = default, decimal? newPrice = default, decimal? newTriggerPrice = default, decimal? newQuantity = default, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ stopOrderId|Stop order id| -|_[Optional]_ clientOrderId|Client order id| -|_[Optional]_ newPrice|New price to set| -|_[Optional]_ newTriggerPrice|New trigger price to set| -|_[Optional]_ newQuantity|New quantity to set| -|_[Optional]_ takeProfitPrice|New take profit price| -|_[Optional]_ stopLossPrice|New stop loss price| -|_[Optional]_ takeProfitTriggerType|New take profit trigger type| -|_[Optional]_ stopLossTriggerType|New stop loss profit price| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## ModifyOrderAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-replaceactive](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-replaceactive) -

- -*Change an exising order. Either orderId or clientOrderId should be provided* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Trading.ModifyOrderAsync(/* parameters */); -``` - -```csharp -Task> ModifyOrderAsync(string symbol, string? orderId = default, string? clientOrderId = default, decimal? newPrice = default, decimal? newQuantity = default, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|_[Optional]_ orderId|Stop order id| -|_[Optional]_ clientOrderId|Client order id| -|_[Optional]_ newPrice|New price to set| -|_[Optional]_ newQuantity|New quantity to set| -|_[Optional]_ takeProfitPrice|New take profit price| -|_[Optional]_ stopLossPrice|New stop loss price| -|_[Optional]_ takeProfitTriggerType|New take profit trigger type| -|_[Optional]_ stopLossTriggerType|New stop loss profit price| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## PlaceConditionalOrderAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-placecond](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-placecond) -

- -*Place a new conditional order* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Trading.PlaceConditionalOrderAsync(/* parameters */); -``` - -```csharp -Task> PlaceConditionalOrderAsync(string symbol, OrderSide side, OrderType type, decimal quantity, decimal basePrice, decimal triggerPrice, TimeInForce timeInForce, bool closeOnTrigger, bool reduceOnly, decimal? price = default, TriggerType? triggerType = default, string? clientOrderId = default, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, PositionMode? positionMode = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|side|Order side| -|type|Order type| -|quantity|Quantity| -|basePrice|It will be used to compare with the value of trigger price, to decide whether your conditional order will be triggered by crossing trigger price from upper side or lower side. Mainly used to identify the expected direction of the current conditional order.| -|triggerPrice|Trigger price| -|timeInForce|Time in force| -|closeOnTrigger|For a closing order. It can only reduce your position, not increase it. If the account has insufficient available balance when the closing order is triggered, then other active orders of similar contracts will be cancelled or reduced. It can be used to ensure your stop loss reduces your position regardless of current available margin.| -|reduceOnly|True means your position can only reduce in size if this order is triggered. When reduce_only is true, take profit/stop loss cannot be set| -|_[Optional]_ price|Price| -|_[Optional]_ triggerType|Trigger type| -|_[Optional]_ clientOrderId|Client order id| -|_[Optional]_ takeProfitPrice|Take profit price, only take effect upon opening the position| -|_[Optional]_ stopLossPrice|Stop loss price, only take effect upon opening the position| -|_[Optional]_ takeProfitTriggerType|Take profit trigger price type, default: LastPrice| -|_[Optional]_ stopLossTriggerType|Stop loss trigger price type, default: LastPrice| -|_[Optional]_ positionMode|Position mode| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## PlaceOrderAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-placeactive](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-placeactive) -

- -*Place a new order* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Trading.PlaceOrderAsync(/* parameters */); -``` - -```csharp -Task> PlaceOrderAsync(string symbol, OrderSide side, OrderType type, decimal quantity, TimeInForce timeInForce, bool reduceOnly, bool closeOnTrigger, decimal? price = default, string? clientOrderId = default, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, PositionMode? positionMode = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|side|Order side| -|type|Order type| -|quantity|Quantity| -|timeInForce|Time in force| -|reduceOnly|True means your position can only reduce in size if this order is triggered| -|closeOnTrigger|For a closing order. It can only reduce your position, not increase it. If the account has insufficient available balance when the closing order is triggered, then other active orders of similar contracts will be cancelled or reduced. It can be used to ensure your stop loss reduces your position regardless of current available margin.| -|_[Optional]_ price|Price| -|_[Optional]_ clientOrderId|Client order id| -|_[Optional]_ takeProfitPrice|Take profit price, only take effect upon opening the position| -|_[Optional]_ stopLossPrice|Stop loss price, only take effect upon opening the position| -|_[Optional]_ takeProfitTriggerType|Take profit trigger price type, default: LastPrice| -|_[Optional]_ stopLossTriggerType|Stop loss trigger price type, default: LastPrice| -|_[Optional]_ positionMode|Position mode| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetTradingStopAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-tradingstop](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-tradingstop) -

- -*Set take profit, stop loss, and trailing stop for your open position* - -```csharp -var client = new BybitRestClient(); -var result = await client.UsdPerpetualApi.Trading.SetTradingStopAsync(/* parameters */); -``` - -```csharp -Task SetTradingStopAsync(string symbol, PositionSide side, decimal? takeProfitPrice = default, decimal? stopLossPrice = default, decimal? trailingStopPrice = default, TriggerType? takeProfitTriggerType = default, TriggerType? stopLossTriggerType = default, decimal? takeProfitQuantity = default, decimal? stopLossQuantity = default, PositionMode? positionMode = default, long? receiveWindow = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol| -|side|The position side| -|_[Optional]_ takeProfitPrice|The new take profit price. Setting it to null will not change the value, setting it to 0 will remove the current TakeProfit| -|_[Optional]_ stopLossPrice|The new stop loss price. Setting it to null will not change the value, setting it to 0 will remove the current StopLoss| -|_[Optional]_ trailingStopPrice|Setting it to null will not change the value, setting it to 0 will remove the current TrailingStop| -|_[Optional]_ takeProfitTriggerType|Take profit trigger type, defaults to LastPrice| -|_[Optional]_ stopLossTriggerType|Stop loss trigger type, defaults to LastPrice| -|_[Optional]_ takeProfitQuantity|Take profit quantity when in Partial mode| -|_[Optional]_ stopLossQuantity|Stop loss quantity when in Partial mode| -|_[Optional]_ positionMode|Position mode| -|_[Optional]_ receiveWindow|The receive window for which this request is active. When the request takes longer than this to complete the server will reject the request| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/UsdPerpetualApi/IBybitSocketClientUsdPerpetualApi.md b/docs/ClientInfo/UsdPerpetualApi/IBybitSocketClientUsdPerpetualApi.md deleted file mode 100644 index 80b39153..00000000 --- a/docs/ClientInfo/UsdPerpetualApi/IBybitSocketClientUsdPerpetualApi.md +++ /dev/null @@ -1,482 +0,0 @@ ---- -title: IBybitSocketClientUsdPerpetualApi -has_children: true -parent: Socket API documentation ---- -*[generated documentation]* -`BybitSocketClient > UsdPerpetualApi` -*[DEPRECATED, WILL STOP WORKING ON 16/30 OCTOBER, USE V5 API INSTEAD] Bybit usd perpetual streams* - - -*** - -## SubscribeToBalanceUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketwallet](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketwallet) -

- -*Subscribe to user balance updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.UsdPerpetualApi.SubscribeToBalanceUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToBalanceUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToKlineUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketkline](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketkline) -

- -*Subscribe to kline (candlestick) updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.UsdPerpetualApi.SubscribeToKlineUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToKlineUpdatesAsync(string symbol, KlineInterval interval, Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to receive updates for| -|interval|The interval of the klines| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToKlineUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketkline](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketkline) -

- -*Subscribe to kline (candlestick) updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.UsdPerpetualApi.SubscribeToKlineUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToKlineUpdatesAsync(IEnumerable symbols, KlineInterval interval, Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to receive updates for| -|interval|The interval of the klines| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToLiquidationsUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketliquidation](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketliquidation) -

- -*Subscribe to liquidation order updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.UsdPerpetualApi.SubscribeToLiquidationsUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToLiquidationsUpdatesAsync(Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToLiquidationUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketliquidation](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketliquidation) -

- -*Subscribe to liquidation order updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.UsdPerpetualApi.SubscribeToLiquidationUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToLiquidationUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to receive updates for| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToLiquidationUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketliquidation](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketliquidation) -

- -*Subscribe to liquidation order updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.UsdPerpetualApi.SubscribeToLiquidationUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToLiquidationUpdatesAsync(IEnumerable symbols, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to receive updates for| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToOrderBooksUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketorderbook25](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketorderbook25) -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketorderbook200](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketorderbook200) -

- -*Subscribe to orderbook updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.UsdPerpetualApi.SubscribeToOrderBooksUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToOrderBooksUpdatesAsync(int limit, Action>> snapshotHandler, Action>> updateHandler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|limit|The amount of rows to receive updates for. Either 25 or 200.| -|snapshotHandler|The event handler for the initial snapshot data| -|updateHandler|The event handler for the update messages| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToOrderBookUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketorderbook25](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketorderbook25) -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketorderbook200](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketorderbook200) -

- -*Subscribe to orderbook updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.UsdPerpetualApi.SubscribeToOrderBookUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToOrderBookUpdatesAsync(string symbol, int limit, Action>> snapshotHandler, Action>> updateHandler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to receive updates for| -|limit|The amount of rows to receive updates for. Either 25 or 200.| -|snapshotHandler|The event handler for the initial snapshot data| -|updateHandler|The event handler for the update messages| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToOrderBookUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketorderbook25](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketorderbook25) -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketorderbook200](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketorderbook200) -

- -*Subscribe to orderbook updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.UsdPerpetualApi.SubscribeToOrderBookUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToOrderBookUpdatesAsync(IEnumerable symbols, int limit, Action>> snapshotHandler, Action>> updateHandler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to receive updates for| -|limit|The amount of rows to receive updates for. Either 25 or 200.| -|snapshotHandler|The event handler for the initial snapshot data| -|updateHandler|The event handler for the update messages| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToOrderUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketorder](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketorder) -

- -*Subscribe to user order updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.UsdPerpetualApi.SubscribeToOrderUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToOrderUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToPositionUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketposition](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketposition) -

- -*Subscribe to user position updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.UsdPerpetualApi.SubscribeToPositionUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToPositionUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToStopOrderUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketstoporder](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketstoporder) -

- -*Subscribe to user stop order updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.UsdPerpetualApi.SubscribeToStopOrderUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToStopOrderUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToTickerUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketinstrumentinfo](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketinstrumentinfo) -

- -*Subscribe to ticker updates. Note that for a symbol the first update is a snapshot, containing all info. After that only partial updates are given for* -*properties which have changed. If a property in the update is `null` it isn't changed and should be ignored.* - -```csharp -var client = new BybitSocketClient(); -var result = await client.UsdPerpetualApi.SubscribeToTickerUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTickerUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to receive updates for| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToTickerUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketinstrumentinfo](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketinstrumentinfo) -

- -*Subscribe to ticker updates. Note that for a symbol the first update is a snapshot, containing all info. After that only partial updates are given for* -*properties which have changed. If a property in the update is `null` it isn't changed and should be ignored.* - -```csharp -var client = new BybitSocketClient(); -var result = await client.UsdPerpetualApi.SubscribeToTickerUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTickerUpdatesAsync(IEnumerable symbols, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to receive updates for| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToTradesUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websockettrade](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websockettrade) -

- -*Subscribe to public trade updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.UsdPerpetualApi.SubscribeToTradesUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTradesUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToTradeUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websockettrade](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websockettrade) -

- -*Subscribe to public trade updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.UsdPerpetualApi.SubscribeToTradeUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTradeUpdatesAsync(string symbol, Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to receive updates for| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToTradeUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websockettrade](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websockettrade) -

- -*Subscribe to public trade updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.UsdPerpetualApi.SubscribeToTradeUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTradeUpdatesAsync(IEnumerable symbols, Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to receive updates for| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

- -*** - -## SubscribeToUserTradeUpdatesAsync - -[https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketexecution](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocketexecution) -

- -*Subscribe to user trade updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.UsdPerpetualApi.SubscribeToUserTradeUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToUserTradeUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|The event handler for the received data| -|_[Optional]_ ct|Cancellation token for closing this subscription| - -

diff --git a/docs/ClientInfo/V5/IBybitRestClientApi.md b/docs/ClientInfo/V5/IBybitRestClientApi.md deleted file mode 100644 index 339bbaae..00000000 --- a/docs/ClientInfo/V5/IBybitRestClientApi.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: IBybitRestClientApi -has_children: true -parent: IBybitRestClientV5 -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > V5 > Api` -*Bybit V5 API endpoints* - -*** -*Get the ISpotClient for this client. This is a common interface which allows for some basic operations without knowing any details of the exchange.* -**ISpotClient CommonSpotClient { get; }** -*** -*Endpoints related to account settings, info or actions* -**[IBybitRestClientApiAccount](IBybitRestClientApiAccount.html) Account { get; }** -*** -*Endpoints related to retrieving market and system data* -**[IBybitRestClientApiExchangeData](IBybitRestClientApiExchangeData.html) ExchangeData { get; }** -*** -*Endpoint for managing sub accounts* -**[IBybitRestClientApiSubAccounts](IBybitRestClientApiSubAccounts.html) SubAccount { get; }** -*** -*Endpoints related to orders and trades* -**[IBybitRestClientApiTrading](IBybitRestClientApiTrading.html) Trading { get; }** diff --git a/docs/ClientInfo/V5/IBybitRestClientApiAccount.md b/docs/ClientInfo/V5/IBybitRestClientApiAccount.md deleted file mode 100644 index 7e8d2420..00000000 --- a/docs/ClientInfo/V5/IBybitRestClientApiAccount.md +++ /dev/null @@ -1,1105 +0,0 @@ ---- -title: IBybitRestClientApiAccount -has_children: false -parent: IBybitRestClientV5 -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > V5 > ApiAccount` -*Bybit account endpoints. Account endpoints include balance info, withdraw/deposit info and requesting and changing account settings* - - -*** - -## AddOrReduceMarginAsync - -[https://bybit-exchange.github.io/docs/v5/position/manual-add-margin](https://bybit-exchange.github.io/docs/v5/position/manual-add-margin) -

- -*Manually add or reduce margin for isolated margin position* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.AddOrReduceMarginAsync(/* parameters */); -``` - -```csharp -Task> AddOrReduceMarginAsync(Category category, string symbol, decimal margin, PositionIdx? positionIdx = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|symbol|Symbol| -|margin|Margin. Positive for adding, negative for reducing| -|_[Optional]_ positionIdx|Position idx| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## CancelWithdrawalAsync - -[https://bybit-exchange.github.io/docs/v5/asset/cancel-withdraw](https://bybit-exchange.github.io/docs/v5/asset/cancel-withdraw) -

- -*Cancel a withdrawal* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.CancelWithdrawalAsync(/* parameters */); -``` - -```csharp -Task> CancelWithdrawalAsync(string id, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|id|The id of the withdrawal to cancel| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## CreateInternalTransferAsync - -[https://bybit-exchange.github.io/docs/v5/asset/create-inter-transfer](https://bybit-exchange.github.io/docs/v5/asset/create-inter-transfer) -

- -*Create an internal transfer between different account types* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.CreateInternalTransferAsync(/* parameters */); -``` - -```csharp -Task> CreateInternalTransferAsync(string asset, decimal quantity, AccountType fromAccountType, AccountType toAccountType, string? transferId = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|asset|Coin| -|quantity|Quantity| -|fromAccountType|From account type| -|toAccountType|To account type| -|_[Optional]_ transferId|Client id| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## CreateUniversalTransferAsync - -[https://bybit-exchange.github.io/docs/v5/asset/unitransfer](https://bybit-exchange.github.io/docs/v5/asset/unitransfer) -

- -*Transfer between main/sub accounts* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.CreateUniversalTransferAsync(/* parameters */); -``` - -```csharp -Task> CreateUniversalTransferAsync(string asset, decimal quantity, string fromMemberId, string toMemberId, AccountType fromAccountType, AccountType toAccountType, string? transferId = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|asset|The asset| -|quantity|Quantity| -|fromMemberId|From member id| -|toMemberId|To member id| -|fromAccountType|From account type| -|toAccountType|To account type| -|_[Optional]_ transferId|Client id| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## DeleteApiKeyAsync - -[https://bybit-exchange.github.io/docs/v5/user/rm-master-apikey](https://bybit-exchange.github.io/docs/v5/user/rm-master-apikey) -

- -*Delete the current API Key* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.DeleteApiKeyAsync(); -``` - -```csharp -Task DeleteApiKeyAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|| - -

- -*** - -## EditApiKeyAsync - -[https://bybit-exchange.github.io/docs/v5/user/modify-master-apikey](https://bybit-exchange.github.io/docs/v5/user/modify-master-apikey) -

- -*Edit master API key settings* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.EditApiKeyAsync(); -``` - -```csharp -Task> EditApiKeyAsync(bool? readOnly = default, string? ipRestrictions = default, bool? permissionContractTradeOrder = default, bool? permissionContractTradePosition = default, bool? permissionSpotTrade = default, bool? permissionWalletTransfer = default, bool? permissionWalletSubAccountTransfer = default, bool? permissionOptionsTrade = default, bool? permissionCopyTrading = default, bool? permissionBlockTrading = default, bool? permissionExchangeHistory = default, bool? permissionNftProductList = default, bool? permissionAffiliate = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ readOnly|Readonly| -|_[Optional]_ ipRestrictions|IP restrictions, comma seperated| -|_[Optional]_ permissionContractTradeOrder|Has contract order permission| -|_[Optional]_ permissionContractTradePosition|Has contract position permission| -|_[Optional]_ permissionSpotTrade|Has spot trade permission| -|_[Optional]_ permissionWalletTransfer|Has wallet transfer permission| -|_[Optional]_ permissionWalletSubAccountTransfer|Has permission wallet subaccount transfer permission| -|_[Optional]_ permissionOptionsTrade|Has option trade permission| -|_[Optional]_ permissionCopyTrading|Has copy trade permission| -|_[Optional]_ permissionBlockTrading|Has block trade permission| -|_[Optional]_ permissionExchangeHistory|Has exchange history permission| -|_[Optional]_ permissionNftProductList|Has NFT product list permission| -|_[Optional]_ permissionAffiliate|Has affiliate permission| -|_[Optional]_ ct|Cancelation token| - -

- -*** - -## GetAccountTypesAsync - -[https://bybit-exchange.github.io/docs/v5/user/wallet-type](https://bybit-exchange.github.io/docs/v5/user/wallet-type) -

- -*Get account types* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.GetAccountTypesAsync(); -``` - -```csharp -Task>> GetAccountTypesAsync(IEnumerable? subAccountIds = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ subAccountIds|Master id can request subaccount info| -|_[Optional]_ ct|| - -

- -*** - -## GetAllAssetBalancesAsync - -[https://bybit-exchange.github.io/docs/v5/asset/all-balance](https://bybit-exchange.github.io/docs/v5/asset/all-balance) -

- -*Get all balances* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.GetAllAssetBalancesAsync(/* parameters */); -``` - -```csharp -Task> GetAllAssetBalancesAsync(AccountType accountType, string? memberId = default, string? asset = default, bool? withBonus = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|accountType|Account tpye| -|_[Optional]_ memberId|Member id| -|_[Optional]_ asset|Asset| -|_[Optional]_ withBonus|Include bonus| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetAllowedDepositAssetInfoAsync - -[https://bybit-exchange.github.io/docs/v5/asset/deposit-coin-spec](https://bybit-exchange.github.io/docs/v5/asset/deposit-coin-spec) -

- -*Get allowed deposit asset info* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.GetAllowedDepositAssetInfoAsync(); -``` - -```csharp -Task> GetAllowedDepositAssetInfoAsync(string? asset = default, string? network = default, int? limit = default, string? cursor = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|Filter on asset| -|_[Optional]_ network|Filter on network| -|_[Optional]_ limit|Number of results per page| -|_[Optional]_ cursor|Pagination cursor| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetApiKeyInfoAsync - -[https://bybit-exchange.github.io/docs/v5/user/apikey-info](https://bybit-exchange.github.io/docs/v5/user/apikey-info) -

- -*Get api key info for the current api key* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.GetApiKeyInfoAsync(); -``` - -```csharp -Task> GetApiKeyInfoAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetAssetBalanceAsync - -[https://bybit-exchange.github.io/docs/v5/asset/account-coin-balance](https://bybit-exchange.github.io/docs/v5/asset/account-coin-balance) -

- -*Get asset balance* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.GetAssetBalanceAsync(/* parameters */); -``` - -```csharp -Task> GetAssetBalanceAsync(AccountType accountType, string asset, string? memberId = default, bool? withBonus = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|accountType|Account type| -|asset|The asset| -|_[Optional]_ memberId|Member id| -|_[Optional]_ withBonus|Include bonus| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetAssetGreeksAsync - -[https://bybit-exchange.github.io/docs/v5/account/coin-greeks](https://bybit-exchange.github.io/docs/v5/account/coin-greeks) -

- -*Get current account greek info* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.GetAssetGreeksAsync(); -``` - -```csharp -Task>> GetAssetGreeksAsync(string? baseAsset = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ baseAsset|Base asset| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetAssetInfoAsync - -[https://bybit-exchange.github.io/docs/v5/asset/coin-info](https://bybit-exchange.github.io/docs/v5/asset/coin-info) -

- -*Get coin info including chain info and withdrawal and deposit status* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.GetAssetInfoAsync(); -``` - -```csharp -Task> GetAssetInfoAsync(string? asset = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetAssetInfoAsync - -[https://bybit-exchange.github.io/docs/v5/asset/asset-info](https://bybit-exchange.github.io/docs/v5/asset/asset-info) -

- -*Get asset information* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.GetAssetInfoAsync(/* parameters */); -``` - -```csharp -Task> GetAssetInfoAsync(AccountType accountType, string? asset = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|accountType|Account type (spot only atm)| -|_[Optional]_ asset|Filter asset| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetBalancesAsync - -[https://bybit-exchange.github.io/docs/v5/account/wallet-balance](https://bybit-exchange.github.io/docs/v5/account/wallet-balance) -

- -*Get wallet balance and account info* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.GetBalancesAsync(/* parameters */); -``` - -```csharp -Task>> GetBalancesAsync(AccountType accountType, string? asset = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|accountType|Account info| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetBorrowHistoryAsync - -[https://bybit-exchange.github.io/docs/v5/account/borrow-history](https://bybit-exchange.github.io/docs/v5/account/borrow-history) -

- -*Get borrow history* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.GetBorrowHistoryAsync(); -``` - -```csharp -Task>> GetBorrowHistoryAsync(string? asset = default, DateTime? startTime = default, DateTime? endTime = default, int? limit = default, string? cursor = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ limit|Number of results per page| -|_[Optional]_ cursor|Pagination cursor| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetCollateralInfoAsync - -[https://bybit-exchange.github.io/docs/v5/account/collateral-info](https://bybit-exchange.github.io/docs/v5/account/collateral-info) -

- -*Get the collateral information of the current unified margin account, including loan interest rate, loanable amount, collateral conversion rate, whether it can be mortgaged as margin, etc.* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.GetCollateralInfoAsync(); -``` - -```csharp -Task>> GetCollateralInfoAsync(string? asset = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetDelayedWithdrawQuantityAsync - -[https://bybit-exchange.github.io/docs/v5/asset/delay-amount](https://bybit-exchange.github.io/docs/v5/asset/delay-amount) -

- -*Get delayed withdrawal amount* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.GetDelayedWithdrawQuantityAsync(/* parameters */); -``` - -```csharp -Task> GetDelayedWithdrawQuantityAsync(string asset, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|asset|The asset| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetDepositAddressAsync - -[https://bybit-exchange.github.io/docs/v5/asset/master-deposit-addr](https://bybit-exchange.github.io/docs/v5/asset/master-deposit-addr) -

- -*Get the master deposit address for an asset* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.GetDepositAddressAsync(/* parameters */); -``` - -```csharp -Task> GetDepositAddressAsync(string asset, string? networkType = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|asset|Asset| -|_[Optional]_ networkType|Network type| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetDepositsAsync - -[https://bybit-exchange.github.io/docs/v5/asset/deposit-record](https://bybit-exchange.github.io/docs/v5/asset/deposit-record) -

- -*Get list of deposits* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.GetDepositsAsync(); -``` - -```csharp -Task> GetDepositsAsync(string? asset = default, DateTime? startTime = default, DateTime? endTime = default, int? limit = default, string? cursor = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ limit|Number of results per page| -|_[Optional]_ cursor|Pagination cursor| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetFeeRateAsync - -[https://bybit-exchange.github.io/docs/v5/account/fee-rate](https://bybit-exchange.github.io/docs/v5/account/fee-rate) -

- -*Get fee rates* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.GetFeeRateAsync(/* parameters */); -``` - -```csharp -Task>> GetFeeRateAsync(Category category, string? symbol = default, string? baseAsset = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|_[Optional]_ symbol|Filter by symbol| -|_[Optional]_ baseAsset|Filter by base asset| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetInternalTransfersAsync - -[https://bybit-exchange.github.io/docs/v5/asset/inter-transfer-list](https://bybit-exchange.github.io/docs/v5/asset/inter-transfer-list) -

- -*Get internal transfer history* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.GetInternalTransfersAsync(); -``` - -```csharp -Task>> GetInternalTransfersAsync(string? transferId = default, string? asset = default, TransferStatus? transferStatus = default, DateTime? startTime = default, DateTime? endTime = default, int? limit = default, string? cursor = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ transferId|Filter by tansfer id| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ transferStatus|Filter by status| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ limit|Number of results per page| -|_[Optional]_ cursor|Pagination cursor| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetMarginAccountInfoAsync - -[https://bybit-exchange.github.io/docs/v5/account/account-info](https://bybit-exchange.github.io/docs/v5/account/account-info) -

- -*Get margin configuration info* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.GetMarginAccountInfoAsync(); -``` - -```csharp -Task> GetMarginAccountInfoAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetSpotMarginDataAsync - -[https://bybit-exchange.github.io/docs/v5/spot-margin-uta/vip-margin](https://bybit-exchange.github.io/docs/v5/spot-margin-uta/vip-margin) -

- -*Get spot margin data* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.GetSpotMarginDataAsync(); -``` - -```csharp -Task>> GetSpotMarginDataAsync(string? asset = default, string? vipLevel = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ vipLevel|Filter by VIP level| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetSpotMarginStatusAndLeverageAsync - -[https://bybit-exchange.github.io/docs/v5/spot-margin-uta/status](https://bybit-exchange.github.io/docs/v5/spot-margin-uta/status) -

- -*Query the Spot margin status and leverage of Unified account* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.GetSpotMarginStatusAndLeverageAsync(); -``` - -```csharp -Task> GetSpotMarginStatusAndLeverageAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetTransactionHistoryAsync - -[https://bybit-exchange.github.io/docs/v5/account/transaction-log](https://bybit-exchange.github.io/docs/v5/account/transaction-log) -

- -*Get transaction logs in Unified account.* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.GetTransactionHistoryAsync(); -``` - -```csharp -Task>> GetTransactionHistoryAsync(AccountType? accountType = default, Category? category = default, string? asset = default, string? baseAsset = default, TransactionLogType? type = default, DateTime? startTime = default, DateTime? endTime = default, int? limit = default, string? cursor = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ accountType|Filter by account type| -|_[Optional]_ category|Filter by category| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ baseAsset|Filter by base asset| -|_[Optional]_ type|Filter by type| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ limit|Number of results per page| -|_[Optional]_ cursor|Pagination cursor| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetTransferableAssetsAsync - -[https://bybit-exchange.github.io/docs/v5/asset/transferable-coin](https://bybit-exchange.github.io/docs/v5/asset/transferable-coin) -

- -*Get a list of transferable assets between accounts* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.GetTransferableAssetsAsync(/* parameters */); -``` - -```csharp -Task>> GetTransferableAssetsAsync(AccountType fromAccountType, AccountType toAccountType, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|fromAccountType|From account type| -|toAccountType|To account type| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetUniversalTransfersAsync - -[https://bybit-exchange.github.io/docs/v5/asset/unitransfer-list](https://bybit-exchange.github.io/docs/v5/asset/unitransfer-list) -

- -*Get universal transfer history* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.GetUniversalTransfersAsync(); -``` - -```csharp -Task>> GetUniversalTransfersAsync(string? transferId = default, string? asset = default, TransferStatus? transferStatus = default, DateTime? startTime = default, DateTime? endTime = default, int? limit = default, string? cursor = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ transferId|Filter by tansfer id| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ transferStatus|Filter by status| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ limit|Number of results per page| -|_[Optional]_ cursor|Pagination cursor| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetWithdrawalsAsync - -[https://bybit-exchange.github.io/docs/v5/asset/withdraw-record](https://bybit-exchange.github.io/docs/v5/asset/withdraw-record) -

- -*Get withdrawal history* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.GetWithdrawalsAsync(); -``` - -```csharp -Task>> GetWithdrawalsAsync(string? withdrawId = default, string? asset = default, WithdrawalType? type = default, DateTime? startTime = default, DateTime? endTime = default, int? limit = default, string? cursor = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ withdrawId|Filter by withdrawal id| -|_[Optional]_ asset|Filter by asset| -|_[Optional]_ type|Filter by type| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ limit|Number of results per page| -|_[Optional]_ cursor|Pagination cursor| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetAutoAddMarginAsync - -[https://bybit-exchange.github.io/docs/v5/position/add-margin](https://bybit-exchange.github.io/docs/v5/position/add-margin) -

- -*Set auto add margin* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.SetAutoAddMarginAsync(/* parameters */); -``` - -```csharp -Task SetAutoAddMarginAsync(Category category, string symbol, bool autoAddMargin, PositionIdx? positionIdx = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|symbol|Symbol| -|autoAddMargin|Auto add margin or not| -|_[Optional]_ positionIdx|Position idx| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetDepositAccountAsync - -[https://bybit-exchange.github.io/docs/v5/asset/set-deposit-acct](https://bybit-exchange.github.io/docs/v5/asset/set-deposit-acct) -

- -*Set the account deposits are credited to* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.SetDepositAccountAsync(/* parameters */); -``` - -```csharp -Task> SetDepositAccountAsync(AccountType accountType, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|accountType|The account| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetLeverageAsync - -[https://bybit-exchange.github.io/docs/v5/position/leverage](https://bybit-exchange.github.io/docs/v5/position/leverage) -

- -*Set leverage* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.SetLeverageAsync(/* parameters */); -``` - -```csharp -Task SetLeverageAsync(Category category, string symbol, decimal buyLeverage, decimal sellLeverage, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|symbol|Symbol| -|buyLeverage|Buy leverage. Must be the same as sellLeverage under one-way mode| -|sellLeverage|Sell leverage. Must be the same as sellLeverage under one-way mode| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetMarginModeAsync - -[https://bybit-exchange.github.io/docs/v5/account/set-margin-mode](https://bybit-exchange.github.io/docs/v5/account/set-margin-mode) -

- -*Set the margin mode* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.SetMarginModeAsync(/* parameters */); -``` - -```csharp -Task> SetMarginModeAsync(MarginMode marginMode, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|marginMode|Margin mode| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetRiskLimitAsync - -[https://bybit-exchange.github.io/docs/v5/position/set-risk-limit](https://bybit-exchange.github.io/docs/v5/position/set-risk-limit) -

- -*Set the risk limit* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.SetRiskLimitAsync(/* parameters */); -``` - -```csharp -Task> SetRiskLimitAsync(Category category, string symbol, int riskId, PositionIdx? positionIdx = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|symbol|Symbol| -|riskId|Risk id| -|_[Optional]_ positionIdx|Position idx| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetSpotMarginLeverageAsync - -[https://bybit-exchange.github.io/docs/v5/spot-margin-uta/set-leverage](https://bybit-exchange.github.io/docs/v5/spot-margin-uta/set-leverage) -

- -*Set the user's maximum leverage in spot cross margin* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.SetSpotMarginLeverageAsync(/* parameters */); -``` - -```csharp -Task SetSpotMarginLeverageAsync(decimal leverage, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|leverage|New leverage| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetSpotMarginTradeModeAsync - -[https://bybit-exchange.github.io/docs/v5/spot-margin-uta/status](https://bybit-exchange.github.io/docs/v5/spot-margin-uta/status) -

- -*Turn on / off spot margin trade* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.SetSpotMarginTradeModeAsync(/* parameters */); -``` - -```csharp -Task> SetSpotMarginTradeModeAsync(bool spotMarginMode, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|spotMarginMode|True to enable, false to disable| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetTakeProfitStopLossModeAsync - -[https://bybit-exchange.github.io/docs/v5/position/tpsl-mode](https://bybit-exchange.github.io/docs/v5/position/tpsl-mode) -

- -*Set take profit/stop loss mode* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.SetTakeProfitStopLossModeAsync(/* parameters */); -``` - -```csharp -Task> SetTakeProfitStopLossModeAsync(Category category, string symbol, StopLossTakeProfitMode tpSlMode, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|symbol|Symbol| -|tpSlMode|Mode| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SwitchCrossIsolatedMarginAsync - -[https://bybit-exchange.github.io/docs/v5/position/cross-isolate](https://bybit-exchange.github.io/docs/v5/position/cross-isolate) -

- -*Switch cross or isolated margin mode* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.SwitchCrossIsolatedMarginAsync(/* parameters */); -``` - -```csharp -Task SwitchCrossIsolatedMarginAsync(Category category, string symbol, TradeMode tradeMode, decimal buyLeverage, decimal sellLeverage, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|symbol|Symbol| -|tradeMode|Trade mode| -|buyLeverage|Buy leverage| -|sellLeverage|Sell leverage| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SwitchPositionModeAsync - -[https://bybit-exchange.github.io/docs/v5/position/position-mode](https://bybit-exchange.github.io/docs/v5/position/position-mode) -

- -*Switch position mode* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.SwitchPositionModeAsync(/* parameters */); -``` - -```csharp -Task SwitchPositionModeAsync(Category category, Enums.V5.PositionMode mode, string? symbol = default, string? asset = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|mode|Mode| -|_[Optional]_ symbol|Symbol| -|_[Optional]_ asset|Asset| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## WithdrawAsync - -[https://bybit-exchange.github.io/docs/v5/asset/withdraw](https://bybit-exchange.github.io/docs/v5/asset/withdraw) -

- -*Withdraw funds* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiAccount.WithdrawAsync(/* parameters */); -``` - -```csharp -Task> WithdrawAsync(string asset, string network, string toAddress, decimal quantity, string? tag = default, bool? forceNetwork = default, AccountType? accountType = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|asset|Asset| -|network|Network to use| -|toAddress|Target address| -|quantity|Quantity| -|_[Optional]_ tag|Tag| -|_[Optional]_ forceNetwork|Force on-chain withdrawal| -|_[Optional]_ accountType|Account type to withdraw from| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/V5/IBybitRestClientApiExchangeData.md b/docs/ClientInfo/V5/IBybitRestClientApiExchangeData.md deleted file mode 100644 index eefe296c..00000000 --- a/docs/ClientInfo/V5/IBybitRestClientApiExchangeData.md +++ /dev/null @@ -1,621 +0,0 @@ ---- -title: IBybitRestClientApiExchangeData -has_children: false -parent: IBybitRestClientV5 -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > V5 > ApiExchangeData` -*Bybit exchange data endpoints. Exchange data includes market data (tickers, order books, etc) and system status.* - - -*** - -## GetAnnouncementsAsync - -[https://bybit-exchange.github.io/docs/v5/announcement](https://bybit-exchange.github.io/docs/v5/announcement) -

- -*Get server announcements* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiExchangeData.GetAnnouncementsAsync(/* parameters */); -``` - -```csharp -Task>> GetAnnouncementsAsync(string locale, string? type = default, string? tag = default, int? page = default, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|locale|Language| -|_[Optional]_ type|Filter by type| -|_[Optional]_ tag|Filter by tag| -|_[Optional]_ page|Page| -|_[Optional]_ limit|Page size| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetDeliveryPriceAsync - -[https://bybit-exchange.github.io/docs/v5/market/delivery-price](https://bybit-exchange.github.io/docs/v5/market/delivery-price) -

- -*Get delivery price* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiExchangeData.GetDeliveryPriceAsync(/* parameters */); -``` - -```csharp -Task>> GetDeliveryPriceAsync(Category category, string? symbol = default, string? baseAsset = default, int? limit = default, string? cursor = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|_[Optional]_ symbol|Filter by symbol| -|_[Optional]_ baseAsset|Filter by base asset| -|_[Optional]_ limit|Number of results per page| -|_[Optional]_ cursor|Pagination cursor| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetFundingRateHistoryAsync - -[https://bybit-exchange.github.io/docs/v5/market/history-fund-rate](https://bybit-exchange.github.io/docs/v5/market/history-fund-rate) -

- -*Get funding rate history* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiExchangeData.GetFundingRateHistoryAsync(/* parameters */); -``` - -```csharp -Task>> GetFundingRateHistoryAsync(Category category, string symbol, DateTime? startTime = default, DateTime? endTime = default, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|symbol|Symbol| -|_[Optional]_ startTime|Fitler by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ limit|Number of results| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetHistoricalVolatilityAsync - -[https://bybit-exchange.github.io/docs/v5/market/iv](https://bybit-exchange.github.io/docs/v5/market/iv) -

- -*Get historical volatility* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiExchangeData.GetHistoricalVolatilityAsync(/* parameters */); -``` - -```csharp -Task>> GetHistoricalVolatilityAsync(Category category, string? baseAsset = default, int? period = default, DateTime? startTime = default, DateTime? endTime = default, int? limit = default, string? cursor = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|_[Optional]_ baseAsset|Filter by base asset| -|_[Optional]_ period|Period| -|_[Optional]_ startTime|Fitler by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ limit|Number of results per page| -|_[Optional]_ cursor|Pagination cursor| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetIndexPriceKlinesAsync - -[https://bybit-exchange.github.io/docs/v5/market/index-kline](https://bybit-exchange.github.io/docs/v5/market/index-kline) -

- -*Get index price klines* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiExchangeData.GetIndexPriceKlinesAsync(/* parameters */); -``` - -```csharp -Task>> GetIndexPriceKlinesAsync(Category category, string symbol, KlineInterval interval, DateTime? startTime = default, DateTime? endTime = default, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|symbol|Symbol| -|interval|Kline interval| -|_[Optional]_ startTime|Fitler by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ limit|Number of results| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetInsuranceAsync - -[https://bybit-exchange.github.io/docs/v5/market/insurance](https://bybit-exchange.github.io/docs/v5/market/insurance) -

- -*Get insurance pool data* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiExchangeData.GetInsuranceAsync(); -``` - -```csharp -Task>> GetInsuranceAsync(string? asset = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ asset|Asset| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetKlinesAsync - -[https://bybit-exchange.github.io/docs/v5/market/kline](https://bybit-exchange.github.io/docs/v5/market/kline) -

- -*Get klines* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiExchangeData.GetKlinesAsync(/* parameters */); -``` - -```csharp -Task>> GetKlinesAsync(Category category, string symbol, KlineInterval interval, DateTime? startTime = default, DateTime? endTime = default, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|symbol|Symbol| -|interval|Kline interval| -|_[Optional]_ startTime|Fitler by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ limit|Number of results| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetLeverageTokenMarketAsync - -[https://bybit-exchange.github.io/docs/v5/lt/leverage-token-reference](https://bybit-exchange.github.io/docs/v5/lt/leverage-token-reference) -

- -*Get leveraged token market info* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiExchangeData.GetLeverageTokenMarketAsync(/* parameters */); -``` - -```csharp -Task> GetLeverageTokenMarketAsync(string leverageToken, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|leverageToken|Token| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetLeverageTokensAsync - -[https://bybit-exchange.github.io/docs/v5/lt/leverage-token-info](https://bybit-exchange.github.io/docs/v5/lt/leverage-token-info) -

- -*Get leverage token info* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiExchangeData.GetLeverageTokensAsync(); -``` - -```csharp -Task>> GetLeverageTokensAsync(string? leverageToken = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ leverageToken|Filter by token| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetLinearInverseSymbolsAsync - -[https://bybit-exchange.github.io/docs/v5/market/instrument](https://bybit-exchange.github.io/docs/v5/market/instrument) -

- -*Get linear/inverse symbols* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiExchangeData.GetLinearInverseSymbolsAsync(/* parameters */); -``` - -```csharp -Task>> GetLinearInverseSymbolsAsync(Category category, string? symbol = default, string? baseAsset = default, int? limit = default, string? cursor = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|_[Optional]_ symbol|Symbol| -|_[Optional]_ baseAsset|Base asset| -|_[Optional]_ limit|Number of results per page| -|_[Optional]_ cursor|Pagination cursor| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetLinearInverseTickersAsync - -[https://bybit-exchange.github.io/docs/v5/market/tickers](https://bybit-exchange.github.io/docs/v5/market/tickers) -

- -*Get linear/inverse tickers* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiExchangeData.GetLinearInverseTickersAsync(/* parameters */); -``` - -```csharp -Task>> GetLinearInverseTickersAsync(Category category, string? symbol = default, string? baseAsset = default, string? expirationDate = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|_[Optional]_ symbol|Symbol| -|_[Optional]_ baseAsset|Base asset| -|_[Optional]_ expirationDate|Expiration date| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetMarkPriceKlinesAsync - -[https://bybit-exchange.github.io/docs/v5/market/mark-kline](https://bybit-exchange.github.io/docs/v5/market/mark-kline) -

- -*Get mark price klines* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiExchangeData.GetMarkPriceKlinesAsync(/* parameters */); -``` - -```csharp -Task>> GetMarkPriceKlinesAsync(Category category, string symbol, KlineInterval interval, DateTime? startTime = default, DateTime? endTime = default, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|symbol|Symbol| -|interval|Kline interval| -|_[Optional]_ startTime|Fitler by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ limit|Number of results| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOpenInterestAsync - -[https://bybit-exchange.github.io/docs/v5/market/open-interest](https://bybit-exchange.github.io/docs/v5/market/open-interest) -

- -*Get open interest* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiExchangeData.GetOpenInterestAsync(/* parameters */); -``` - -```csharp -Task>> GetOpenInterestAsync(Category category, string symbol, OpenInterestInterval interestInterval, DateTime? startTime = default, DateTime? endTime = default, int? limit = default, string? cursor = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|symbol|Symbol| -|interestInterval|Interval| -|_[Optional]_ startTime|Fitler by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ limit|Number of results per page| -|_[Optional]_ cursor|Pagination cursor| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOptionSymbolsAsync - -[https://bybit-exchange.github.io/docs/v5/market/instrument](https://bybit-exchange.github.io/docs/v5/market/instrument) -

- -*Get option symbols* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiExchangeData.GetOptionSymbolsAsync(); -``` - -```csharp -Task>> GetOptionSymbolsAsync(string? symbol = default, string? baseAsset = default, int? limit = default, string? cursor = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ symbol|Symbol| -|_[Optional]_ baseAsset|Base asset| -|_[Optional]_ limit|Number of results per page| -|_[Optional]_ cursor|Pagination cursor| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOptionTickersAsync - -[https://bybit-exchange.github.io/docs/v5/market/tickers](https://bybit-exchange.github.io/docs/v5/market/tickers) -

- -*Get option tickers* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiExchangeData.GetOptionTickersAsync(); -``` - -```csharp -Task>> GetOptionTickersAsync(string? symbol = default, string? baseAsset = default, string? expirationDate = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ symbol|Filter by symbol| -|_[Optional]_ baseAsset|Filter by asset| -|_[Optional]_ expirationDate|Expiration date| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOrderbookAsync - -[https://bybit-exchange.github.io/docs/v5/market/orderbook](https://bybit-exchange.github.io/docs/v5/market/orderbook) -

- -*Get order book* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiExchangeData.GetOrderbookAsync(/* parameters */); -``` - -```csharp -Task> GetOrderbookAsync(Category category, string symbol, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|symbol|Symbol| -|_[Optional]_ limit|Limit of results| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetPremiumIndexPriceKlinesAsync - -[https://bybit-exchange.github.io/docs/v5/market/preimum-index-kline](https://bybit-exchange.github.io/docs/v5/market/preimum-index-kline) -

- -*Get premium index klines* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiExchangeData.GetPremiumIndexPriceKlinesAsync(/* parameters */); -``` - -```csharp -Task>> GetPremiumIndexPriceKlinesAsync(Category category, string symbol, KlineInterval interval, DateTime? startTime = default, DateTime? endTime = default, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|symbol|Symbol| -|interval|Kline interval| -|_[Optional]_ startTime|Fitler by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ limit|Number of results per page| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetRiskLimitAsync - -

- -*Get risk limits* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiExchangeData.GetRiskLimitAsync(/* parameters */); -``` - -```csharp -Task>> GetRiskLimitAsync(Category category, string? symbol = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|_[Optional]_ symbol|Symbol| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetServerTimeAsync - -[https://bybit-exchange.github.io/docs/v3/server-time](https://bybit-exchange.github.io/docs/v3/server-time) -

- -*Get server time* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiExchangeData.GetServerTimeAsync(); -``` - -```csharp -Task> GetServerTimeAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetSpotSymbolsAsync - -[https://bybit-exchange.github.io/docs/v5/market/instrument](https://bybit-exchange.github.io/docs/v5/market/instrument) -

- -*Get spot symbols* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiExchangeData.GetSpotSymbolsAsync(); -``` - -```csharp -Task>> GetSpotSymbolsAsync(string? symbol = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ symbol|Filter by symbol| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetSpotTickersAsync - -[https://bybit-exchange.github.io/docs/v5/market/tickers](https://bybit-exchange.github.io/docs/v5/market/tickers) -

- -*Spot tickers* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiExchangeData.GetSpotTickersAsync(); -``` - -```csharp -Task>> GetSpotTickersAsync(string? symbol = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ symbol|Filter by symbol| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetTradeHistoryAsync - -[https://bybit-exchange.github.io/docs/v5/market/recent-trade](https://bybit-exchange.github.io/docs/v5/market/recent-trade) -

- -*Get trade history* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiExchangeData.GetTradeHistoryAsync(/* parameters */); -``` - -```csharp -Task>> GetTradeHistoryAsync(Category category, string symbol, string? baseAsset = default, OptionType? optionType = default, int? limit = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|symbol|Symbol| -|_[Optional]_ baseAsset|Base asset| -|_[Optional]_ optionType|Option type| -|_[Optional]_ limit|Limit of results| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/V5/IBybitRestClientApiSubAccounts.md b/docs/ClientInfo/V5/IBybitRestClientApiSubAccounts.md deleted file mode 100644 index d77fb059..00000000 --- a/docs/ClientInfo/V5/IBybitRestClientApiSubAccounts.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -title: IBybitRestClientApiSubAccounts -has_children: false -parent: IBybitRestClientV5 -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > V5 > ApiSubAccounts` -*Bybit sub account endpoints* - - -*** - -## CreateSubAccountApiKeyAsync - -[https://bybit-exchange.github.io/docs/v5/user/create-subuid-apikey](https://bybit-exchange.github.io/docs/v5/user/create-subuid-apikey) -

- -*Create a new API key for a sub account* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiSubAccounts.CreateSubAccountApiKeyAsync(/* parameters */); -``` - -```csharp -Task> CreateSubAccountApiKeyAsync(string subAccountId, bool readOnly, bool? permissionContractTradeOrder = default, bool? permissionContractTradePosition = default, bool? permissionSpotTrade = default, bool? permissionWalletTransfer = default, bool? permissionWalletSubAccountTransfer = default, bool? permissionOptionsTrade = default, bool? permissionExchangeHistory = default, bool? permissionCopyTrading = default, string? ipRestrictions = default, string? note = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|subAccountId|Subaccount id| -|readOnly|Readonly key| -|_[Optional]_ permissionContractTradeOrder|Has contract order permission| -|_[Optional]_ permissionContractTradePosition|Has contract position permission| -|_[Optional]_ permissionSpotTrade|Has spot trade permission| -|_[Optional]_ permissionWalletTransfer|Has wallet transfer permission| -|_[Optional]_ permissionWalletSubAccountTransfer|Has permission wallet subaccount transfer permission| -|_[Optional]_ permissionOptionsTrade|Has option trade permission| -|_[Optional]_ permissionExchangeHistory|Has exchange history permission| -|_[Optional]_ permissionCopyTrading|Has copy trade permission| -|_[Optional]_ ipRestrictions|Ip restrictions, comma seperated| -|_[Optional]_ note|Note| -|_[Optional]_ ct|Cancelation token| - -

- -*** - -## CreateSubAccountAsync - -[https://bybit-exchange.github.io/docs/v5/user/create-subuid](https://bybit-exchange.github.io/docs/v5/user/create-subuid) -

- -*Create a new sub account* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiSubAccounts.CreateSubAccountAsync(/* parameters */); -``` - -```csharp -Task> CreateSubAccountAsync(string username, SubAccountType type, string? password = default, bool? enableQuickLogin = default, bool? isUta = default, string? note = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|username|Username| -|type|Account type| -|_[Optional]_ password|Password, 8-30 characters, must include numbers, upper and lowercase letters| -|_[Optional]_ enableQuickLogin|Enable quick login| -|_[Optional]_ isUta|Uta account| -|_[Optional]_ note|Set a remark| -|_[Optional]_ ct|Cancelation token| - -

- -*** - -## DeleteSubAccountApiKeyAsync - -[https://bybit-exchange.github.io/docs/v5/user/rm-sub-apikey](https://bybit-exchange.github.io/docs/v5/user/rm-sub-apikey) -

- -*Delete an API key* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiSubAccounts.DeleteSubAccountApiKeyAsync(); -``` - -```csharp -Task DeleteSubAccountApiKeyAsync(string? apiKey = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ apiKey|Api key, should be passed if deleting from Master account, should be null if editing own API key from sub account| -|_[Optional]_ ct|Cancelation token| - -

- -*** - -## EditSubAccountApiKeyAsync - -[https://bybit-exchange.github.io/docs/v5/user/modify-sub-apikey](https://bybit-exchange.github.io/docs/v5/user/modify-sub-apikey) -

- -*Edit API key* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiSubAccounts.EditSubAccountApiKeyAsync(); -``` - -```csharp -Task> EditSubAccountApiKeyAsync(string? apiKey = default, bool? readOnly = default, string? ipRestrictions = default, bool? permissionContractTradeOrder = default, bool? permissionContractTradePosition = default, bool? permissionSpotTrade = default, bool? permissionWalletTransfer = default, bool? permissionWalletSubAccountTransfer = default, bool? permissionOptionsTrade = default, bool? permissionCopyTrading = default, bool? permissionExchangeHistory = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ apiKey|Api key, should be passed if editing from Master account, should be null if editing own API key from sub account| -|_[Optional]_ readOnly|Readonly| -|_[Optional]_ ipRestrictions|IP restrictions, comma seperated| -|_[Optional]_ permissionContractTradeOrder|Has contract order permission| -|_[Optional]_ permissionContractTradePosition|Has contract position permission| -|_[Optional]_ permissionSpotTrade|Has spot trade permission| -|_[Optional]_ permissionWalletTransfer|Has wallet transfer permission| -|_[Optional]_ permissionWalletSubAccountTransfer|Has permission wallet subaccount transfer permission| -|_[Optional]_ permissionOptionsTrade|Has option trade permission| -|_[Optional]_ permissionCopyTrading|Has copy trade permission| -|_[Optional]_ permissionExchangeHistory|Has exchange history permission| -|_[Optional]_ ct|Cancelation token| - -

- -*** - -## GetSubAccountsAsync - -[https://bybit-exchange.github.io/docs/v5/user/subuid-list](https://bybit-exchange.github.io/docs/v5/user/subuid-list) -

- -*Get list of subaccounts* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiSubAccounts.GetSubAccountsAsync(); -``` - -```csharp -Task>> GetSubAccountsAsync(CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ ct|Cancelation token| - -

diff --git a/docs/ClientInfo/V5/IBybitRestClientApiTrading.md b/docs/ClientInfo/V5/IBybitRestClientApiTrading.md deleted file mode 100644 index 8c9b7427..00000000 --- a/docs/ClientInfo/V5/IBybitRestClientApiTrading.md +++ /dev/null @@ -1,659 +0,0 @@ ---- -title: IBybitRestClientApiTrading -has_children: false -parent: IBybitRestClientV5 -grand_parent: Rest API documentation ---- -*[generated documentation]* -`BybitRestClient > V5 > ApiTrading` -*Bybit trading endpoints, placing and managing orders.* - - -*** - -## CancelAllOrderAsync - -[https://bybit-exchange.github.io/docs/v5/order/cancel-all](https://bybit-exchange.github.io/docs/v5/order/cancel-all) -

- -*Cancel all orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiTrading.CancelAllOrderAsync(/* parameters */); -``` - -```csharp -Task>> CancelAllOrderAsync(Category category, string? symbol = default, string? baseAsset = default, string? settleAsset = default, OrderFilter? orderFilter = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|_[Optional]_ symbol|Filter by symbol| -|_[Optional]_ baseAsset|Filter by base asset| -|_[Optional]_ settleAsset|Filter by settle asset| -|_[Optional]_ orderFilter|Order filter| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## CancelMultipleOrdersAsync - -[https://bybit-exchange.github.io/docs/v5/order/batch-cancel](https://bybit-exchange.github.io/docs/v5/order/batch-cancel) -

- -*Cancel multiple orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiTrading.CancelMultipleOrdersAsync(/* parameters */); -``` - -```csharp -Task>>> CancelMultipleOrdersAsync(Category category, IEnumerable orderRequests, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|The category| -|orderRequests|Request data| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## CancelOrderAsync - -[https://bybit-exchange.github.io/docs/v5/order/cancel-order](https://bybit-exchange.github.io/docs/v5/order/cancel-order) -

- -*Cancel order* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiTrading.CancelOrderAsync(/* parameters */); -``` - -```csharp -Task> CancelOrderAsync(Category category, string symbol, string? orderId = default, string? clientOrderId = default, OrderFilter? orderFilter = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|symbol|Symbol| -|_[Optional]_ orderId|Cancel by order id| -|_[Optional]_ clientOrderId|Cancel by client order id| -|_[Optional]_ orderFilter|Order filter| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## EditMultipleOrdersAsync - -[https://bybit-exchange.github.io/docs/v5/order/batch-amend](https://bybit-exchange.github.io/docs/v5/order/batch-amend) -

- -*Edit multiple orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiTrading.EditMultipleOrdersAsync(/* parameters */); -``` - -```csharp -Task>>> EditMultipleOrdersAsync(Category category, IEnumerable orderRequests, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|The category| -|orderRequests|Request data| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## EditOrderAsync - -[https://bybit-exchange.github.io/docs/v5/order/amend-order](https://bybit-exchange.github.io/docs/v5/order/amend-order) -

- -*Edit an order* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiTrading.EditOrderAsync(/* parameters */); -``` - -```csharp -Task> EditOrderAsync(Category category, string symbol, string? orderId = default, string? clientOrderId = default, decimal? quantity = default, decimal? price = default, decimal? triggerPrice = default, TriggerType? triggerBy = default, decimal? orderIv = default, decimal? takeProfit = default, decimal? stopLoss = default, TriggerType? takeProfitTriggerBy = default, TriggerType? stopLossTriggerBy = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|symbol|Symbol| -|_[Optional]_ orderId|Order id of the order to edit| -|_[Optional]_ clientOrderId|Client order id of the order to edit| -|_[Optional]_ quantity|New quantity| -|_[Optional]_ price|New price| -|_[Optional]_ triggerPrice|New trigger price| -|_[Optional]_ triggerBy|New trigger | -|_[Optional]_ orderIv|New order Iv| -|_[Optional]_ takeProfit|New take profit price| -|_[Optional]_ stopLoss|New stop loss price| -|_[Optional]_ takeProfitTriggerBy|New take profit trigger| -|_[Optional]_ stopLossTriggerBy|New stop profit trigger| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetAssetExchangeHistoryAsync - -[https://bybit-exchange.github.io/docs/v5/asset/exchange](https://bybit-exchange.github.io/docs/v5/asset/exchange) -

- -*Get asset exchange history* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiTrading.GetAssetExchangeHistoryAsync(); -``` - -```csharp -Task>> GetAssetExchangeHistoryAsync(string? fromAsset = default, string? toAsset = default, int? limit = default, string? cursor = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ fromAsset|Filter by from asset| -|_[Optional]_ toAsset|Filter by to asset| -|_[Optional]_ limit|Number of results per page| -|_[Optional]_ cursor|Pagination cursor| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetBorrowQuotaAsync - -[https://bybit-exchange.github.io/docs/v5/order/spot-borrow-quota](https://bybit-exchange.github.io/docs/v5/order/spot-borrow-quota) -

- -*Get spot borrow quota* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiTrading.GetBorrowQuotaAsync(/* parameters */); -``` - -```csharp -Task> GetBorrowQuotaAsync(Category category, string symbol, OrderSide side, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|symbol|Symbol| -|side|Side| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetClosedProfitLossAsync - -[https://bybit-exchange.github.io/docs/v5/position/close-pnl](https://bybit-exchange.github.io/docs/v5/position/close-pnl) -

- -*Get closed profit and loss* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiTrading.GetClosedProfitLossAsync(/* parameters */); -``` - -```csharp -Task>> GetClosedProfitLossAsync(Category category, string? symbol = default, DateTime? startTime = default, DateTime? endTime = default, int? limit = default, string? cursor = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|_[Optional]_ symbol|Filter by symbol| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ limit|Number of results per page| -|_[Optional]_ cursor|Pagination cursor| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetDeliveryHistoryAsync - -[https://bybit-exchange.github.io/docs/v5/asset/delivery](https://bybit-exchange.github.io/docs/v5/asset/delivery) -

- -*Get delivery history* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiTrading.GetDeliveryHistoryAsync(/* parameters */); -``` - -```csharp -Task>> GetDeliveryHistoryAsync(Category category, string? symbol = default, DateTime? expiryDate = default, int? limit = default, string? cursor = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|_[Optional]_ symbol|Filter by symbol| -|_[Optional]_ expiryDate|Filter by expiry date| -|_[Optional]_ limit|Number of results per page| -|_[Optional]_ cursor|Pagination cursor| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetLeverageTokenOrderHistoryAsync - -[https://bybit-exchange.github.io/docs/v5/lt/order-record](https://bybit-exchange.github.io/docs/v5/lt/order-record) -

- -*Get leverage token order history* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiTrading.GetLeverageTokenOrderHistoryAsync(); -``` - -```csharp -Task>> GetLeverageTokenOrderHistoryAsync(string? token = default, string? orderId = default, string? clientOrderId = default, DateTime? startTime = default, DateTime? endTime = default, int? limit = default, LeverageTokenRecordType? type = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|_[Optional]_ token|Filter by token| -|_[Optional]_ orderId|Filter by order id| -|_[Optional]_ clientOrderId|Filter by client order id| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ limit|Max number of results| -|_[Optional]_ type|Filter by type or record| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOrderHistoryAsync - -[https://bybit-exchange.github.io/docs/v5/order/order-list](https://bybit-exchange.github.io/docs/v5/order/order-list) -

- -*Get order history* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiTrading.GetOrderHistoryAsync(/* parameters */); -``` - -```csharp -Task>> GetOrderHistoryAsync(Category category, string? symbol = default, string? baseAsset = default, string? orderId = default, string? clientOrderId = default, Enums.V5.OrderStatus? status = default, OrderFilter? orderFilter = default, DateTime? startTime = default, DateTime? endTime = default, int? limit = default, string? cursor = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|_[Optional]_ symbol|Filter by symbol| -|_[Optional]_ baseAsset|Filter by base asset| -|_[Optional]_ orderId|Filter by order id| -|_[Optional]_ clientOrderId|Filter by client order id| -|_[Optional]_ status|Filter by status| -|_[Optional]_ orderFilter|Order filter| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ limit|Number of results per page| -|_[Optional]_ cursor|Pagination cursor| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetOrdersAsync - -[https://bybit-exchange.github.io/docs/v5/order/open-order](https://bybit-exchange.github.io/docs/v5/order/open-order) -

- -*Get real-time open orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiTrading.GetOrdersAsync(/* parameters */); -``` - -```csharp -Task>> GetOrdersAsync(Category category, string? symbol = default, string? baseAsset = default, string? settleAsset = default, string? orderId = default, string? clientOrderId = default, int? openOnly = default, OrderFilter? orderFilter = default, int? limit = default, string? cursor = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|_[Optional]_ symbol|Filter by symbol| -|_[Optional]_ baseAsset|Filter by base asset| -|_[Optional]_ settleAsset|Filter by settle asset| -|_[Optional]_ orderId|Filter by order id| -|_[Optional]_ clientOrderId|Filter by client order id| -|_[Optional]_ openOnly|Open only| -|_[Optional]_ orderFilter|Order filter| -|_[Optional]_ limit|Number of results per page| -|_[Optional]_ cursor|Pagination cursor| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetPositionsAsync - -[https://bybit-exchange.github.io/docs/v5/position](https://bybit-exchange.github.io/docs/v5/position) -

- -*Get positions* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiTrading.GetPositionsAsync(/* parameters */); -``` - -```csharp -Task>> GetPositionsAsync(Category category, string? symbol = default, string? baseAsset = default, string? settleAsset = default, int? limit = default, string? cursor = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|_[Optional]_ symbol|Filter by symbol| -|_[Optional]_ baseAsset|Filter by base asset| -|_[Optional]_ settleAsset|Filter by settle asset| -|_[Optional]_ limit|Number of results per page| -|_[Optional]_ cursor|Pagination cursor| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetSettlementHistoryAsync - -[https://bybit-exchange.github.io/docs/v5/asset/settlement](https://bybit-exchange.github.io/docs/v5/asset/settlement) -

- -*Get settlement history* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiTrading.GetSettlementHistoryAsync(/* parameters */); -``` - -```csharp -Task>> GetSettlementHistoryAsync(Category category, string? symbol = default, int? limit = default, string? cursor = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|_[Optional]_ symbol|Filter by symbol| -|_[Optional]_ limit|Number of results per page| -|_[Optional]_ cursor|Pagination cursor| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## GetUserTradesAsync - -[https://bybit-exchange.github.io/docs/v5/position/execution](https://bybit-exchange.github.io/docs/v5/position/execution) -

- -*Get user trade history* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiTrading.GetUserTradesAsync(/* parameters */); -``` - -```csharp -Task>> GetUserTradesAsync(Category category, string? symbol = default, string? baseAsset = default, string? orderId = default, string? clientOrderId = default, DateTime? startTime = default, DateTime? endTime = default, TradeType? tradeType = default, int? limit = default, string? cursor = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|_[Optional]_ symbol|Filter by symbol| -|_[Optional]_ baseAsset|Filter by base asset| -|_[Optional]_ orderId|Filter by order id| -|_[Optional]_ clientOrderId|Filter by client order id| -|_[Optional]_ startTime|Filter by start time| -|_[Optional]_ endTime|Filter by end time| -|_[Optional]_ tradeType|Filter by trade type| -|_[Optional]_ limit|Number of results per page| -|_[Optional]_ cursor|Pagination cursor| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## PlaceMultipleOrdersAsync - -[https://bybit-exchange.github.io/docs/v5/order/batch-place](https://bybit-exchange.github.io/docs/v5/order/batch-place) -

- -*Place multiple orders* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiTrading.PlaceMultipleOrdersAsync(/* parameters */); -``` - -```csharp -Task>>> PlaceMultipleOrdersAsync(Category category, IEnumerable orderRequests, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|The category| -|orderRequests|Request data| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## PlaceOrderAsync - -[https://bybit-exchange.github.io/docs/v5/order/create-order](https://bybit-exchange.github.io/docs/v5/order/create-order) -

- -*Place an order* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiTrading.PlaceOrderAsync(/* parameters */); -``` - -```csharp -Task> PlaceOrderAsync(Category category, string symbol, OrderSide side, NewOrderType type, decimal quantity, decimal? price = default, bool? isLeverage = default, TriggerDirection? triggerDirection = default, OrderFilter? orderFilter = default, decimal? triggerPrice = default, TriggerType? triggerBy = default, decimal? orderIv = default, TimeInForce? timeInForce = default, PositionIdx? positionIdx = default, string? clientOrderId = default, OrderType? takeProfitOrderType = default, decimal? takeProfit = default, decimal? takeProfitLimitPrice = default, OrderType? stopLossOrderType = default, decimal? stopLoss = default, decimal? stopLossLimitPrice = default, TriggerType? takeProfitTriggerBy = default, TriggerType? stopLossTriggerBy = default, bool? reduceOnly = default, bool? closeOnTrigger = default, bool? marketMakerProtection = default, StopLossTakeProfitMode? stopLossTakeProfitMode = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|symbol|Symbol| -|side|Order side| -|type|Order type| -|quantity|Quantity| -|_[Optional]_ price|Price| -|_[Optional]_ isLeverage|Is leverage| -|_[Optional]_ triggerDirection|Conditional order diraction| -|_[Optional]_ orderFilter|Order filter| -|_[Optional]_ triggerPrice|Trigger price| -|_[Optional]_ triggerBy|Trigger by| -|_[Optional]_ orderIv|Order implied volatility| -|_[Optional]_ timeInForce|Time in force| -|_[Optional]_ positionIdx|Position idx| -|_[Optional]_ clientOrderId|Client order id| -|_[Optional]_ takeProfitOrderType|| -|_[Optional]_ takeProfit|Take profit price| -|_[Optional]_ takeProfitLimitPrice|| -|_[Optional]_ stopLossOrderType|| -|_[Optional]_ stopLoss|Stop loss price| -|_[Optional]_ stopLossLimitPrice|| -|_[Optional]_ takeProfitTriggerBy|Take profit trigger| -|_[Optional]_ stopLossTriggerBy|Stop loss trigger| -|_[Optional]_ reduceOnly|Is reduce only| -|_[Optional]_ closeOnTrigger|Close on trigger| -|_[Optional]_ marketMakerProtection|Market maker protection| -|_[Optional]_ stopLossTakeProfitMode|StopLoss / TakeProfit mode| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## PurchaseLeverageTokenAsync - -[https://bybit-exchange.github.io/docs/v5/lt/purchase](https://bybit-exchange.github.io/docs/v5/lt/purchase) -

- -*Purchase a leverage token* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiTrading.PurchaseLeverageTokenAsync(/* parameters */); -``` - -```csharp -Task> PurchaseLeverageTokenAsync(string token, decimal quantity, string? clientOrderId = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|token|Token id| -|quantity|Quantity| -|_[Optional]_ clientOrderId|Custom order id| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## RedeemLeverageTokenAsync - -[https://bybit-exchange.github.io/docs/v5/lt/redeem](https://bybit-exchange.github.io/docs/v5/lt/redeem) -

- -*Redeem a leverage token* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiTrading.RedeemLeverageTokenAsync(/* parameters */); -``` - -```csharp -Task> RedeemLeverageTokenAsync(string token, decimal quantity, string? clientOrderId = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|token|Token id| -|quantity|Quantity| -|_[Optional]_ clientOrderId|Custom order id| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetDisconnectCancelAllAsync - -[https://bybit-exchange.github.io/docs/v5/order/dcp](https://bybit-exchange.github.io/docs/v5/order/dcp) -

- -*Set cancel all timeout on websocket disconnect* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiTrading.SetDisconnectCancelAllAsync(/* parameters */); -``` - -```csharp -Task> SetDisconnectCancelAllAsync(int windowSeconds, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|windowSeconds|Time after which to cancel all orders| -|_[Optional]_ ct|Cancellation token| - -

- -*** - -## SetTradingStopAsync - -[https://bybit-exchange.github.io/docs/v5/position/trading-stop](https://bybit-exchange.github.io/docs/v5/position/trading-stop) -

- -*Set trading stop parameters* - -```csharp -var client = new BybitRestClient(); -var result = await client.V5.ApiTrading.SetTradingStopAsync(/* parameters */); -``` - -```csharp -Task SetTradingStopAsync(Category category, string symbol, PositionIdx positionIdx, decimal? takeProfit = default, decimal? stopLoss = default, decimal? trailingStop = default, TriggerType? takeProfitTrigger = default, TriggerType? stopLossTrigger = default, decimal? activePrice = default, decimal? takeProfitQuantity = default, decimal? stopLossQuantity = default, StopLossTakeProfitMode? stopLossTakeProfitMode = default, decimal? takeProfitLimitPrice = default, decimal? stopLossLimitPrice = default, OrderType? takeProfitOrderType = default, OrderType? stopLossOrderType = default, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|category|Category| -|symbol|Symbol| -|positionIdx|Position idx| -|_[Optional]_ takeProfit|Take profit price| -|_[Optional]_ stopLoss|Stop loss price| -|_[Optional]_ trailingStop|Trailing stop| -|_[Optional]_ takeProfitTrigger|Take profit trigger| -|_[Optional]_ stopLossTrigger|Stop loss trigger| -|_[Optional]_ activePrice|Active price| -|_[Optional]_ takeProfitQuantity|Take profit quantity| -|_[Optional]_ stopLossQuantity|Stop loss quantity| -|_[Optional]_ stopLossTakeProfitMode|StopLoss/TakeProfit mode| -|_[Optional]_ takeProfitLimitPrice|Take profit order limit price| -|_[Optional]_ stopLossLimitPrice|Stop loss order price| -|_[Optional]_ takeProfitOrderType|Take profit order type| -|_[Optional]_ stopLossOrderType|Stop loss order type| -|_[Optional]_ ct|Cancellation token| - -

diff --git a/docs/ClientInfo/V5/IBybitSocketClientBaseApi.md b/docs/ClientInfo/V5/IBybitSocketClientBaseApi.md deleted file mode 100644 index 88aa2381..00000000 --- a/docs/ClientInfo/V5/IBybitSocketClientBaseApi.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -title: IBybitSocketClientBaseApi -has_children: true -parent: IBybitSocketClientV5 -grand_parent: Socket API documentation ---- -*[generated documentation]* -`BybitSocketClient > V5 > BaseApi` -*Bybit streaming data subscriptions* - - -*** - -## SubscribeToKlineUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/kline](https://bybit-exchange.github.io/docs/v5/websocket/public/kline) -

- -*Subscribe to kline updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.BaseApi.SubscribeToKlineUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToKlineUpdatesAsync(IEnumerable symbols, KlineInterval interval, Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to subscribe| -|interval|Kline interval| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToKlineUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/kline](https://bybit-exchange.github.io/docs/v5/websocket/public/kline) -

- -*Subscribe to kline updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.BaseApi.SubscribeToKlineUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToKlineUpdatesAsync(string symbol, KlineInterval interval, Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to subscribe| -|interval|Kline interval| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToOrderbookUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/orderbook](https://bybit-exchange.github.io/docs/v5/websocket/public/orderbook) -

- -*Subscribe to order book updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.BaseApi.SubscribeToOrderbookUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToOrderbookUpdatesAsync(IEnumerable symbols, int depth, Action> snapshotHandler, Action> updateHandler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to subscribe| -|depth|The order book depth| -|snapshotHandler|Handler for a snapshot update. Snapshot updates contain the full order book| -|updateHandler|Handler for updates. These will only contain the changed entries| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToOrderbookUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/orderbook](https://bybit-exchange.github.io/docs/v5/websocket/public/orderbook) -

- -*Subscribe to order book updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.BaseApi.SubscribeToOrderbookUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToOrderbookUpdatesAsync(string symbol, int depth, Action> snapshotHandler, Action> updateHandler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to subscribe| -|depth|The order book depth| -|snapshotHandler|Handler for a snapshot update. Snapshot updates contain the full order book| -|updateHandler|Handler for updates. These will only contain the changed entries| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToTradeUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/trade](https://bybit-exchange.github.io/docs/v5/websocket/public/trade) -

- -*Subscribe to public trade updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.BaseApi.SubscribeToTradeUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTradeUpdatesAsync(IEnumerable symbols, Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to subscribe| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToTradeUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/trade](https://bybit-exchange.github.io/docs/v5/websocket/public/trade) -

- -*Subscribe to public trade updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.BaseApi.SubscribeToTradeUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTradeUpdatesAsync(string symbol, Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to subscribe| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

diff --git a/docs/ClientInfo/V5/IBybitSocketClientInverseApi.md b/docs/ClientInfo/V5/IBybitSocketClientInverseApi.md deleted file mode 100644 index 6259fd21..00000000 --- a/docs/ClientInfo/V5/IBybitSocketClientInverseApi.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -title: IBybitSocketClientInverseApi -has_children: true -parent: IBybitSocketClientV5 -grand_parent: Socket API documentation ---- -*[generated documentation]* -`BybitSocketClient > V5 > InverseApi` -*Bybit inverse contract data streams* - - -*** - -## SubscribeToLiquidationUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/liquidation](https://bybit-exchange.github.io/docs/v5/websocket/public/liquidation) -

- -*Subscribe to liquidation updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.InverseApi.SubscribeToLiquidationUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToLiquidationUpdatesAsync(IEnumerable symbols, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to subscribe| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToLiquidationUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/liquidation](https://bybit-exchange.github.io/docs/v5/websocket/public/liquidation) -

- -*Subscribe to liquidation updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.InverseApi.SubscribeToLiquidationUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToLiquidationUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to subscribe| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToTickerUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/ticker](https://bybit-exchange.github.io/docs/v5/websocket/public/ticker) -

- -*Subscribe to ticker updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.InverseApi.SubscribeToTickerUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTickerUpdatesAsync(IEnumerable symbols, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to subscribe| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToTickerUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/ticker](https://bybit-exchange.github.io/docs/v5/websocket/public/ticker) -

- -*Subscribe to ticker updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.InverseApi.SubscribeToTickerUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTickerUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to subscribe| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

diff --git a/docs/ClientInfo/V5/IBybitSocketClientLinearApi.md b/docs/ClientInfo/V5/IBybitSocketClientLinearApi.md deleted file mode 100644 index 3637e105..00000000 --- a/docs/ClientInfo/V5/IBybitSocketClientLinearApi.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -title: IBybitSocketClientLinearApi -has_children: true -parent: IBybitSocketClientV5 -grand_parent: Socket API documentation ---- -*[generated documentation]* -`BybitSocketClient > V5 > LinearApi` -*Bybit linear data streams* - - -*** - -## SubscribeToLiquidationUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/liquidation](https://bybit-exchange.github.io/docs/v5/websocket/public/liquidation) -

- -*Subscribe to liquidation updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.LinearApi.SubscribeToLiquidationUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToLiquidationUpdatesAsync(IEnumerable symbols, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to subscribe| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToLiquidationUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/liquidation](https://bybit-exchange.github.io/docs/v5/websocket/public/liquidation) -

- -*Subscribe to liquidation updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.LinearApi.SubscribeToLiquidationUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToLiquidationUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to subscribe| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToTickerUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/ticker](https://bybit-exchange.github.io/docs/v5/websocket/public/ticker) -

- -*Subscribe to ticker updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.LinearApi.SubscribeToTickerUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTickerUpdatesAsync(IEnumerable symbols, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to subscribe| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToTickerUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/ticker](https://bybit-exchange.github.io/docs/v5/websocket/public/ticker) -

- -*Subscribe to ticker updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.LinearApi.SubscribeToTickerUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTickerUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to subscribe| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

diff --git a/docs/ClientInfo/V5/IBybitSocketClientOptionApi.md b/docs/ClientInfo/V5/IBybitSocketClientOptionApi.md deleted file mode 100644 index e419521d..00000000 --- a/docs/ClientInfo/V5/IBybitSocketClientOptionApi.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -title: IBybitSocketClientOptionApi -has_children: true -parent: IBybitSocketClientV5 -grand_parent: Socket API documentation ---- -*[generated documentation]* -`BybitSocketClient > V5 > OptionApi` -*Bybit option data streams* - - -*** - -## SubscribeToLiquidationUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/liquidation](https://bybit-exchange.github.io/docs/v5/websocket/public/liquidation) -

- -*Subscribe to liquidation updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.OptionApi.SubscribeToLiquidationUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToLiquidationUpdatesAsync(IEnumerable symbols, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to subscribe| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToLiquidationUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/liquidation](https://bybit-exchange.github.io/docs/v5/websocket/public/liquidation) -

- -*Subscribe to liquidation updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.OptionApi.SubscribeToLiquidationUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToLiquidationUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to subscribe| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToTickerUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/ticker](https://bybit-exchange.github.io/docs/v5/websocket/public/ticker) -

- -*Subscribe to ticker updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.OptionApi.SubscribeToTickerUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTickerUpdatesAsync(IEnumerable symbols, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to subscribe| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToTickerUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/ticker](https://bybit-exchange.github.io/docs/v5/websocket/public/ticker) -

- -*Subscribe to ticker updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.OptionApi.SubscribeToTickerUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTickerUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to subscribe| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

diff --git a/docs/ClientInfo/V5/IBybitSocketClientPrivateApi.md b/docs/ClientInfo/V5/IBybitSocketClientPrivateApi.md deleted file mode 100644 index 8b53ca97..00000000 --- a/docs/ClientInfo/V5/IBybitSocketClientPrivateApi.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -title: IBybitSocketClientPrivateApi -has_children: true -parent: IBybitSocketClientV5 -grand_parent: Socket API documentation ---- -*[generated documentation]* -`BybitSocketClient > V5 > PrivateApi` -*Bybit user data streams* - - -*** - -## SubscribeToGreekUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/private/greek](https://bybit-exchange.github.io/docs/v5/websocket/private/greek) -

- -*Subscribe to Greek updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.PrivateApi.SubscribeToGreekUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToGreekUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToOrderUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/private/order](https://bybit-exchange.github.io/docs/v5/websocket/private/order) -

- -*Subscribe to order updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.PrivateApi.SubscribeToOrderUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToOrderUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToPositionUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/private/position](https://bybit-exchange.github.io/docs/v5/websocket/private/position) -

- -*Subscribe to position updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.PrivateApi.SubscribeToPositionUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToPositionUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToUserTradeUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/private/execution](https://bybit-exchange.github.io/docs/v5/websocket/private/execution) -

- -*Subscribe to trade updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.PrivateApi.SubscribeToUserTradeUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToUserTradeUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToWalletUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/private/wallet](https://bybit-exchange.github.io/docs/v5/websocket/private/wallet) -

- -*Subscribe to wallet balance updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.PrivateApi.SubscribeToWalletUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToWalletUpdatesAsync(Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

diff --git a/docs/ClientInfo/V5/IBybitSocketClientSpotApi.md b/docs/ClientInfo/V5/IBybitSocketClientSpotApi.md deleted file mode 100644 index 8e666ff6..00000000 --- a/docs/ClientInfo/V5/IBybitSocketClientSpotApi.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -title: IBybitSocketClientSpotApi -has_children: true -parent: IBybitSocketClientV5 -grand_parent: Socket API documentation ---- -*[generated documentation]* -`BybitSocketClient > V5 > SpotApi` -*Bybit spot data streams* - - -*** - -## SubscribeToLeveragedTokenKlineUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/etp-kline](https://bybit-exchange.github.io/docs/v5/websocket/public/etp-kline) -

- -*Subscribe to leveraged token kline updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.SpotApi.SubscribeToLeveragedTokenKlineUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToLeveragedTokenKlineUpdatesAsync(IEnumerable symbols, KlineInterval interval, Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to subscribe| -|interval|Kline interval| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToLeveragedTokenKlineUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/etp-kline](https://bybit-exchange.github.io/docs/v5/websocket/public/etp-kline) -

- -*Subscribe to leveraged token kline updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.SpotApi.SubscribeToLeveragedTokenKlineUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToLeveragedTokenKlineUpdatesAsync(string symbol, KlineInterval interval, Action>> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to subscribe| -|interval|Kline interval| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToLeveragedTokenNavUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/etp-nav](https://bybit-exchange.github.io/docs/v5/websocket/public/etp-nav) -

- -*Subscribe to leveraged token NAV updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.SpotApi.SubscribeToLeveragedTokenNavUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToLeveragedTokenNavUpdatesAsync(IEnumerable symbols, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to subscribe| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToLeveragedTokenNavUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/etp-nav](https://bybit-exchange.github.io/docs/v5/websocket/public/etp-nav) -

- -*Subscribe to leveraged token NAV updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.SpotApi.SubscribeToLeveragedTokenNavUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToLeveragedTokenNavUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to subscribe| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToLeveragedTokenTickerUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/etp-ticker](https://bybit-exchange.github.io/docs/v5/websocket/public/etp-ticker) -

- -*Subscribe to leveraged token ticker updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.SpotApi.SubscribeToLeveragedTokenTickerUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToLeveragedTokenTickerUpdatesAsync(IEnumerable symbols, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to subscribe| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToLeveragedTokenTickerUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/etp-ticker](https://bybit-exchange.github.io/docs/v5/websocket/public/etp-ticker) -

- -*Subscribe to leveraged token ticker updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.SpotApi.SubscribeToLeveragedTokenTickerUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToLeveragedTokenTickerUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to subscribe| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToTickerUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/ticker](https://bybit-exchange.github.io/docs/v5/websocket/public/ticker) -

- -*Subscribe to ticker updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.SpotApi.SubscribeToTickerUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTickerUpdatesAsync(IEnumerable symbols, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbols|The symbols to subscribe| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

- -*** - -## SubscribeToTickerUpdatesAsync - -[https://bybit-exchange.github.io/docs/v5/websocket/public/ticker](https://bybit-exchange.github.io/docs/v5/websocket/public/ticker) -

- -*Subscribe to ticker updates* - -```csharp -var client = new BybitSocketClient(); -var result = await client.V5.SpotApi.SubscribeToTickerUpdatesAsync(/* parameters */); -``` - -```csharp -Task> SubscribeToTickerUpdatesAsync(string symbol, Action> handler, CancellationToken ct = default); -``` - -|Parameter|Description| -|---|---| -|symbol|The symbol to subscribe| -|handler|Data handler| -|_[Optional]_ ct|Cancellation token. Cancelling will cancel the subscription| - -

diff --git a/docs/Examples.md b/docs/Examples.md deleted file mode 100644 index 7fe61704..00000000 --- a/docs/Examples.md +++ /dev/null @@ -1,320 +0,0 @@ ---- -title: Examples -nav_order: 3 ---- - -## Basic operations -Make sure to read the [CryptoExchange.Net wiki](https://jkorf.github.io/CryptoExchange.Net/Clients.html#processing-request-responses) on processing responses. - -
- -Spot API - - -
- -### Get market data -```csharp -// Getting info on all symbols -var symbolData = await bybitClient.SpotApi.ExchangeData.GetSymbolsAsync(); - -// Getting tickers for all symbols -var tickerData = await bybitClient.SpotApi.ExchangeData.GetTickersAsync(); - -// Getting the order book of a symbol -var orderBookData = await bybitClient.SpotApi.ExchangeData.GetOrderBookAsync("BTCUSDT"); - -// Getting recent trades of a symbol -var tradeHistoryData = await bybitClient.SpotApi.ExchangeData.GetTradeHistoryAsync("BTC-USDT"); -``` - -### Requesting balances -```csharp -var accountData = await bybitClient.SpotApi.Account.GetBalancesAsync(); -``` -### Placing order -```csharp -// Placing a buy limit order for 0.001 BTC at a price of 50000USDT each -var orderData = await bybitClient.SpotApi.Trading.PlaceOrderAsync( - "BTCUSDT", - OrderSide.Buy, - OrderType.Limit, - 0.001m, - 50000, - timeInForce: TimeInForce.GoodTillCanceled); - -// Placing a buy market order, spending 50 USDT. When placing a Buy Market order the quantity is quote asset. Any other time it's in base asset. -var orderData = await bybitClient.SpotApi.Trading.PlaceOrderAsync( - "BTCUSDT", - OrderSide.Buy, - OrderType.Market, - 50); -``` - -### Requesting a specific order -```csharp -// Request info on order with id `1234` -var orderData = await bybitClient.SpotApi.Trading.GetOrderAsync(1234); -``` - -### Requesting order history -```csharp -// Get all orders conform the parameters - var ordersData = await bybitClient.SpotApi.Trading.GetOrdersAsync(); -``` - -### Cancel order -```csharp -// Cancel order with id `1234` -var orderData = await bybitClient.SpotApi.Trading.CancelOrderAsync(1234); -``` - -### Get user trades -```csharp -var userTradesResult = await bybitClient.SpotApi.Trading.GetUserTradesAsync(); -``` - -### Subscribing to market data updates -```csharp -var subscribeResult = await bybitSocketClient.SpotApi.SubscribeToTickerUpdatesAsync("BTCUSDT", data => -{ - // Handle ticker data -}); -``` - -### Subscribing to order updates -```csharp -await bybitSocketClient.SpotApi.SubscribeToAccountUpdatesAsync( - accountUpdate => - { - // Handle balance or permissions update - }, - orderUpdate => - { - // Handle order update - }, - tradeUpdate => - { - // Handle trade update - }); -``` - -
-
- -
- -Usd perpetual API - - -
- -### Get market data -```csharp - // Getting info on all symbols -var symbolData = await bybitClient.UsdPerpetualApi.ExchangeData.GetSymbolsAsync(); - -// Getting the order book of a symbol -var orderBookData = await bybitClient.UsdPerpetualApi.ExchangeData.GetOrderBookAsync("BTCUSDT"); - -// Getting recent trades of a symbol -var tradeHistoryData = await bybitClient.UsdPerpetualApi.ExchangeData.GetTradeHistoryAsync("BTCUSDT"); -``` - -### Requesting positions -```csharp -// Getting your current positions -var positionResultData = await bybitClient.UsdPerpetualApi.Account.GetPositionsAsync(); -``` - -### Placing order -```csharp -// Placing a Limit Sell order for 0.01 BTC at a price of 50000USDT each -var positionResultData = await bybitClient.UsdPerpetualApi.Trading.PlaceOrderAsync( - "BTCUSDT", - OrderSide.Sell, - OrderType.Limit, - 0.01m, - TimeInForce.GoodTillCanceled, - false, - false, - 50000); -``` - -### Requesting a specific order -```csharp -// Get info on an order id 1234 on symbol BTCUSDT -var orderResult = await bybitClient.UsdPerpetualApi.Trading.GetOpenOrderRealTimeAsync("BTCUSDT", "1234"); - -``` - -### Requesting order history -```csharp -// Get all orders for the account. Can apply filters as parameters -var orderResult = await bybitClient.UsdPerpetualApi.Trading.GetOrdersAsync("BTCUSDT"); -``` - -### Cancel order -```csharp -// Cancel order with id 1234 on symbol BTCUSDT -var orderResult = await bybitClient.UsdPerpetualApi.Trading.CancelOrderAsync("BTCUSDT", "1234"); - -``` - -### Get user trades -```csharp -var userTradesResult = await bybitClient.UsdPerpetualApi.Trading.GetUserTradesAsync("BTCUSDT"); -``` - -### Subscribing to position updates -```csharp -await bybitSocketClient.UsdPerpetualApi.SubscribeToPositionUpdatesAsync( - data => - { - // Handle position update - }); -``` - -
-
- -
- -Inverse futures API - - -
- -### Get market data -```csharp - // Getting info on all symbols -var symbolData = await bybitClient.InverseFuturesApi.ExchangeData.GetSymbolsAsync(); - -// Getting the order book of a symbol -var orderBookData = await bybitClient.InverseFuturesApi.ExchangeData.GetOrderBookAsync("BTCUSDT"); - -// Getting recent trades of a symbol -var tradeHistoryData = await bybitClient.InverseFuturesApi.ExchangeData.GetTradeHistoryAsync("BTCUSDT"); -``` - -### Requesting positions -```csharp -// Getting your current positions -var positionResultData = await bybitClient.InverseFuturesApi.Account.GetPositionsAsync(); -``` - -### Placing order -```csharp -// Placing a Market buy order for 10 USDT -var positionResultData = await bybitClient.InverseFuturesApi.Trading.PlaceOrderAsync( - "BTCUSDM21", - OrderSide.Buy, - OrderType.Market, - PositionMode.BothSideBuy, - 10, - TimeInForce.GoodTillCanceled); -``` - -### Requesting a specific order -```csharp -// Get info on an order id 1234 on symbol BTCUSDM21 -var orderResult = await bybitClient.InverseFuturesApi.Trading.GetOpenOrderRealTimeAsync("BTCUSDM21", "1234"); - -``` - -### Requesting order history -```csharp -// Get all orders for the account. Can apply filters as parameters -var orderResult = await bybitClient.InverseFuturesApi.Trading.GetOrdersAsync("BTCUSDM21"); -``` - -### Cancel order -```csharp -// Cancel order with id 1234 on symbol BTCUSDM21 -var orderResult = await bybitClient.InverseFuturesApi.Trading.CancelOrderAsync("BTCUSDM21", "1234"); - -``` - -### Get user trades -```csharp -var userTradesResult = await bybitClient.InverseFuturesApi.Trading.GetUserTradesAsync("BTCUSDM21"); -``` - -### Streams -The InverseFutures API has no specific streams. The InverseFutures and InversePerpetual streams are equal and available to use via the InversePerpetualsStreams property. - -
-
- -
- -Inverse perpetual API - - -
- -### Get market data -```csharp - // Getting info on all symbols -var symbolData = await bybitClient.InversePerpetualApi.ExchangeData.GetSymbolsAsync(); - -// Getting the order book of a symbol -var orderBookData = await bybitClient.InversePerpetualApi.ExchangeData.GetOrderBookAsync("BTCUSD"); - -// Getting recent trades of a symbol -var tradeHistoryData = await bybitClient.InversePerpetualApi.ExchangeData.GetTradeHistoryAsync("BTCUSD"); -``` - -### Requesting positions -```csharp -// Getting your current positions -var positionResultData = await bybitClient.InversePerpetualApi.Account.GetPositionsAsync(); -``` - -### Placing order -```csharp -// Placing a Market buy order for 10 USDT -var positionResultData = await bybitClient.InversePerpetualApi.Trading.PlaceOrderAsync( - "BTCUSD", - OrderSide.Buy, - OrderType.Market, - 10, - TimeInForce.GoodTillCanceled); -``` - -### Requesting a specific order -```csharp -// Get info on an order id 1234 on symbol BTCUSD -var orderResult = await bybitClient.InversePerpetualApi.Trading.GetOpenOrderRealTimeAsync("BTCUSD", "1234"); - -``` - -### Requesting order history -```csharp -// Get all orders for the account. Can apply filters as parameters -var orderResult = await bybitClient.InversePerpetualApi.Trading.GetOrdersAsync("BTCUSD"); -``` - -### Cancel order -```csharp -// Cancel order with id 1234 on symbol BTCUSD -var orderResult = await bybitClient.InversePerpetualApi.Trading.CancelOrderAsync("BTCUSD", "1234"); - -``` - -### Get user trades -```csharp -var userTradesResult = await bybitClient.InversePerpetualApi.Trading.GetUserTradesAsync("BTCUSD"); -``` - -### Subscribing to position updates -```csharp -await bybitSocketClient.InversePerpetualApi.SubscribeToPositionUpdatesAsync( - data => - { - // Handle position update - }); -``` - -
-
diff --git a/docs/MigrationGuide.md b/docs/MigrationGuide.md deleted file mode 100644 index 2648347e..00000000 --- a/docs/MigrationGuide.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Migrate V2 to V3 -nav_order: 4 ---- - -## Migrate from version V2.x.x to V3.x.x - -There are some breaking changes between V2 and V3, they are detailed in the [CryptoExchange.Net migration guide](https://jkorf.github.io/CryptoExchange.Net/Migration%20Guide.html). diff --git a/docs/Usage.md b/docs/Usage.md deleted file mode 100644 index 90537061..00000000 --- a/docs/Usage.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: Getting started -nav_order: 2 ---- - -## Creating client -There are 2 clients available to interact with the Bybit API, the `BybitRestClient` and `BybitSocketClient`. They can be created manually on the fly or be added to the dotnet DI using the `AddBybit` extension method. - -*Create a new rest client* -```csharp -var bybitRestClient = new BybitRestClient(options => -{ - // Set options here for this client -}); - -var bybitSocketClient = new BybitSocketClient(options = -{ - // Set options here for this client -}); -``` - -*Using dotnet dependency inject* -```csharp -services.AddBybit( - restOptions => { - // set options for the rest client - }, - socketClientOptions => { - // set options for the socket client - }); - -// IBybitRestClient, IBybitSocketClient and IBybitOrderBookFactory are now available for injecting -``` - -Different options are available to set on the clients, see this example -```csharp -var bybitRestClient = new BybitRestClient(options => -{ - options.ApiCredentials = new ApiCredentials("API-KEY", "API-SECRET"); - // override options just for the InverseFuturesOptions api - options.InverseFuturesOptions.ApiCredentials = new ApiCredentials("FUTURES-API-KEY", "FUTURES-API-SECRET"); - options.InverseFuturesOptions.RequestTimeout = TimeSpan.FromSeconds(60); -}); -``` -Alternatively, options can be provided before creating clients by using `SetDefaultOptions` or during the registration in the DI container: -```csharp -BybitRestClient.SetDefaultOptions(options => { - // Set options here for all new clients -}); -var bybitClient = new BybitRestClient(); -``` -More info on the specific options can be found in the [CryptoExchange.Net documentation](https://jkorf.github.io/CryptoExchange.Net/Options.html) - -These clients can be used to communicate with the Bybit exchange. See [Examples](Examples.html) for examples on basic operations - -### Dependency injection -See [CryptoExchange.Net documentation](https://jkorf.github.io/CryptoExchange.Net/Dependency%20Injection.html) - - diff --git a/docs/assets/css/color-blue.css b/docs/assets/css/color-blue.css new file mode 100644 index 00000000..1caa28d3 --- /dev/null +++ b/docs/assets/css/color-blue.css @@ -0,0 +1,159 @@ +/*============================ + COLOR Blue +==============================*/ +::selection { + background: #007bff; +} + +a, a:focus { + color: #007bff; +} + +a:hover, a:active { + color: #006adb; +} + +.primary-menu ul.navbar-nav > li:hover > a:not(.btn), .primary-menu ul.navbar-nav > li > a.active:not(.btn) { + color: #007bff; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #007bff; +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:not(.btn):after { + border-color: #007bff; +} + +/*=== Side Navigation ===*/ +.idocs-navigation .nav .nav .nav-item .nav-link.active:after, .idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link.active:after { + border-color: #007bff; +} + +/* Accordion & Toggle */ +.accordion .card-header a:hover.collapsed { + color: #007bff !important; +} +.accordion:not(.accordion-alternate) .card-header a { + background-color: #007bff; + color: #fff; +} + +/* Nav */ +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover { + color: #007bff; +} + +.nav-tabs .nav-item .nav-link.active { + color: #0c2f55; +} +.nav-tabs .nav-item .nav-link.active:after { + background-color: #007bff; +} +.nav-tabs .nav-item .nav-link:not(.active):hover { + color: #007bff; +} +.nav-tabs.flex-column .nav-item .nav-link.active { + color: #007bff; +} + +.nav-pills .nav-link:not(.active):hover { + color: #007bff; +} + +#footer .nav .nav-item .nav-link:focus { + color: #007bff; +} +#footer .nav .nav-link:hover { + color: #007bff; +} +#footer .footer-copyright .nav .nav-link:hover { + color: #007bff; +} + +/* Back to Top */ +#back-to-top:hover { + background-color: #007bff; +} + +/* Extras */ +.bg-primary, .badge-primary { + background-color: #007bff !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: #007bff !important; +} + +.btn-link:hover { + color: #006adb !important; +} + +.text-muted { + color: #8e9a9d !important; +} + +.text-light { + color: #dee3e4 !important; +} + +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover { + background-color: #006adb !important; +} + +.border-primary { + border-color: #007bff !important; +} + +.btn-primary { + background-color: #007bff; + border-color: #007bff; +} +.btn-primary:hover { + background-color: #006adb; + border-color: #006adb; +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active { + background-color: #006adb; + border-color: #006adb; +} + +.btn-primary.focus, .btn-primary:focus { + background-color: #006adb; + border-color: #006adb; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active { + color: #007bff; + border-color: #007bff; +} +.btn-outline-primary:hover, .btn-outline-primary:not(:disabled):not(.disabled).active:hover, .btn-outline-primary:not(:disabled):not(.disabled):active:hover { + background-color: #007bff; + border-color: #007bff; + color: #fff; +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active { + background-color: #007bff; +} + +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before { + background-color: #007bff; + border-color: #007bff; +} + +.list-group-item.active { + background-color: #007bff; + border-color: #007bff; +} + +.page-link { + color: #007bff; +} +.page-link:hover { + color: #006adb; +} diff --git a/docs/assets/css/color-brown.css b/docs/assets/css/color-brown.css new file mode 100644 index 00000000..4fbb38c7 --- /dev/null +++ b/docs/assets/css/color-brown.css @@ -0,0 +1,159 @@ +/*============================ + COLOR Brown +==============================*/ +::selection { + background: #795548; +} + +a, a:focus { + color: #795548; +} + +a:hover, a:active { + color: #63453b; +} + +.primary-menu ul.navbar-nav > li:hover > a:not(.btn), .primary-menu ul.navbar-nav > li > a.active:not(.btn) { + color: #795548; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #795548; +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:not(.btn):after { + border-color: #795548; +} + +/*=== Side Navigation ===*/ +.idocs-navigation .nav .nav .nav-item .nav-link.active:after, .idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link.active:after { + border-color: #795548; +} + +/* Accordion & Toggle */ +.accordion .card-header a:hover.collapsed { + color: #795548 !important; +} +.accordion:not(.accordion-alternate) .card-header a { + background-color: #795548; + color: #fff; +} + +/* Nav */ +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover { + color: #795548; +} + +.nav-tabs .nav-item .nav-link.active { + color: #0c2f55; +} +.nav-tabs .nav-item .nav-link.active:after { + background-color: #795548; +} +.nav-tabs .nav-item .nav-link:not(.active):hover { + color: #795548; +} +.nav-tabs.flex-column .nav-item .nav-link.active { + color: #795548; +} + +.nav-pills .nav-link:not(.active):hover { + color: #795548; +} + +#footer .nav .nav-item .nav-link:focus { + color: #795548; +} +#footer .nav .nav-link:hover { + color: #795548; +} +#footer .footer-copyright .nav .nav-link:hover { + color: #795548; +} + +/* Back to Top */ +#back-to-top:hover { + background-color: #795548; +} + +/* Extras */ +.bg-primary, .badge-primary { + background-color: #795548 !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: #795548 !important; +} + +.btn-link:hover { + color: #63453b !important; +} + +.text-muted { + color: #8e9a9d !important; +} + +.text-light { + color: #dee3e4 !important; +} + +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover { + background-color: #63453b !important; +} + +.border-primary { + border-color: #795548 !important; +} + +.btn-primary { + background-color: #795548; + border-color: #795548; +} +.btn-primary:hover { + background-color: #63453b; + border-color: #63453b; +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active { + background-color: #63453b; + border-color: #63453b; +} + +.btn-primary.focus, .btn-primary:focus { + background-color: #63453b; + border-color: #63453b; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active { + color: #795548; + border-color: #795548; +} +.btn-outline-primary:hover, .btn-outline-primary:not(:disabled):not(.disabled).active:hover, .btn-outline-primary:not(:disabled):not(.disabled):active:hover { + background-color: #795548; + border-color: #795548; + color: #fff; +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active { + background-color: #795548; +} + +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before { + background-color: #795548; + border-color: #795548; +} + +.list-group-item.active { + background-color: #795548; + border-color: #795548; +} + +.page-link { + color: #795548; +} +.page-link:hover { + color: #63453b; +} diff --git a/docs/assets/css/color-cyan.css b/docs/assets/css/color-cyan.css new file mode 100644 index 00000000..fa712d80 --- /dev/null +++ b/docs/assets/css/color-cyan.css @@ -0,0 +1,159 @@ +/*============================ + COLOR Cyan +==============================*/ +::selection { + background: #17a2b8; +} + +a, a:focus { + color: #17a2b8; +} + +a:hover, a:active { + color: #138698; +} + +.primary-menu ul.navbar-nav > li:hover > a:not(.btn), .primary-menu ul.navbar-nav > li > a.active:not(.btn) { + color: #17a2b8; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #17a2b8; +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:not(.btn):after { + border-color: #17a2b8; +} + +/*=== Side Navigation ===*/ +.idocs-navigation .nav .nav .nav-item .nav-link.active:after, .idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link.active:after { + border-color: #17a2b8; +} + +/* Accordion & Toggle */ +.accordion .card-header a:hover.collapsed { + color: #17a2b8 !important; +} +.accordion:not(.accordion-alternate) .card-header a { + background-color: #17a2b8; + color: #fff; +} + +/* Nav */ +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover { + color: #17a2b8; +} + +.nav-tabs .nav-item .nav-link.active { + color: #0c2f55; +} +.nav-tabs .nav-item .nav-link.active:after { + background-color: #17a2b8; +} +.nav-tabs .nav-item .nav-link:not(.active):hover { + color: #17a2b8; +} +.nav-tabs.flex-column .nav-item .nav-link.active { + color: #17a2b8; +} + +.nav-pills .nav-link:not(.active):hover { + color: #17a2b8; +} + +#footer .nav .nav-item .nav-link:focus { + color: #17a2b8; +} +#footer .nav .nav-link:hover { + color: #17a2b8; +} +#footer .footer-copyright .nav .nav-link:hover { + color: #17a2b8; +} + +/* Back to Top */ +#back-to-top:hover { + background-color: #17a2b8; +} + +/* Extras */ +.bg-primary, .badge-primary { + background-color: #17a2b8 !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: #17a2b8 !important; +} + +.btn-link:hover { + color: #138698 !important; +} + +.text-muted { + color: #8e9a9d !important; +} + +.text-light { + color: #dee3e4 !important; +} + +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover { + background-color: #138698 !important; +} + +.border-primary { + border-color: #17a2b8 !important; +} + +.btn-primary { + background-color: #17a2b8; + border-color: #17a2b8; +} +.btn-primary:hover { + background-color: #138698; + border-color: #138698; +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active { + background-color: #138698; + border-color: #138698; +} + +.btn-primary.focus, .btn-primary:focus { + background-color: #138698; + border-color: #138698; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active { + color: #17a2b8; + border-color: #17a2b8; +} +.btn-outline-primary:hover, .btn-outline-primary:not(:disabled):not(.disabled).active:hover, .btn-outline-primary:not(:disabled):not(.disabled):active:hover { + background-color: #17a2b8; + border-color: #17a2b8; + color: #fff; +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active { + background-color: #17a2b8; +} + +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before { + background-color: #17a2b8; + border-color: #17a2b8; +} + +.list-group-item.active { + background-color: #17a2b8; + border-color: #17a2b8; +} + +.page-link { + color: #17a2b8; +} +.page-link:hover { + color: #138698; +} diff --git a/docs/assets/css/color-green.css b/docs/assets/css/color-green.css new file mode 100644 index 00000000..4810d8b9 --- /dev/null +++ b/docs/assets/css/color-green.css @@ -0,0 +1,159 @@ +/*============================ + COLOR Green +==============================*/ +::selection { + background: #28a745; +} + +a, a:focus { + color: #28a745; +} + +a:hover, a:active { + color: #218a39; +} + +.primary-menu ul.navbar-nav > li:hover > a:not(.btn), .primary-menu ul.navbar-nav > li > a.active:not(.btn) { + color: #28a745; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #28a745; +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:not(.btn):after { + border-color: #28a745; +} + +/*=== Side Navigation ===*/ +.idocs-navigation .nav .nav .nav-item .nav-link.active:after, .idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link.active:after { + border-color: #28a745; +} + +/* Accordion & Toggle */ +.accordion .card-header a:hover.collapsed { + color: #28a745 !important; +} +.accordion:not(.accordion-alternate) .card-header a { + background-color: #28a745; + color: #fff; +} + +/* Nav */ +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover { + color: #28a745; +} + +.nav-tabs .nav-item .nav-link.active { + color: #0c2f55; +} +.nav-tabs .nav-item .nav-link.active:after { + background-color: #28a745; +} +.nav-tabs .nav-item .nav-link:not(.active):hover { + color: #28a745; +} +.nav-tabs.flex-column .nav-item .nav-link.active { + color: #28a745; +} + +.nav-pills .nav-link:not(.active):hover { + color: #28a745; +} + +#footer .nav .nav-item .nav-link:focus { + color: #28a745; +} +#footer .nav .nav-link:hover { + color: #28a745; +} +#footer .footer-copyright .nav .nav-link:hover { + color: #28a745; +} + +/* Back to Top */ +#back-to-top:hover { + background-color: #28a745; +} + +/* Extras */ +.bg-primary, .badge-primary { + background-color: #28a745 !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: #28a745 !important; +} + +.btn-link:hover { + color: #218a39 !important; +} + +.text-muted { + color: #8e9a9d !important; +} + +.text-light { + color: #dee3e4 !important; +} + +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover { + background-color: #218a39 !important; +} + +.border-primary { + border-color: #28a745 !important; +} + +.btn-primary { + background-color: #28a745; + border-color: #28a745; +} +.btn-primary:hover { + background-color: #218a39; + border-color: #218a39; +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active { + background-color: #218a39; + border-color: #218a39; +} + +.btn-primary.focus, .btn-primary:focus { + background-color: #218a39; + border-color: #218a39; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active { + color: #28a745; + border-color: #28a745; +} +.btn-outline-primary:hover, .btn-outline-primary:not(:disabled):not(.disabled).active:hover, .btn-outline-primary:not(:disabled):not(.disabled):active:hover { + background-color: #28a745; + border-color: #28a745; + color: #fff; +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active { + background-color: #28a745; +} + +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before { + background-color: #28a745; + border-color: #28a745; +} + +.list-group-item.active { + background-color: #28a745; + border-color: #28a745; +} + +.page-link { + color: #28a745; +} +.page-link:hover { + color: #218a39; +} diff --git a/docs/assets/css/color-indigo.css b/docs/assets/css/color-indigo.css new file mode 100644 index 00000000..f9141bda --- /dev/null +++ b/docs/assets/css/color-indigo.css @@ -0,0 +1,159 @@ +/*============================ + COLOR Indigo +==============================*/ +::selection { + background: #6610f2; +} + +a, a:focus { + color: #6610f2; +} + +a:hover, a:active { + color: #570bd3; +} + +.primary-menu ul.navbar-nav > li:hover > a:not(.btn), .primary-menu ul.navbar-nav > li > a.active:not(.btn) { + color: #6610f2; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #6610f2; +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:not(.btn):after { + border-color: #6610f2; +} + +/*=== Side Navigation ===*/ +.idocs-navigation .nav .nav .nav-item .nav-link.active:after, .idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link.active:after { + border-color: #6610f2; +} + +/* Accordion & Toggle */ +.accordion .card-header a:hover.collapsed { + color: #6610f2 !important; +} +.accordion:not(.accordion-alternate) .card-header a { + background-color: #6610f2; + color: #fff; +} + +/* Nav */ +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover { + color: #6610f2; +} + +.nav-tabs .nav-item .nav-link.active { + color: #0c2f55; +} +.nav-tabs .nav-item .nav-link.active:after { + background-color: #6610f2; +} +.nav-tabs .nav-item .nav-link:not(.active):hover { + color: #6610f2; +} +.nav-tabs.flex-column .nav-item .nav-link.active { + color: #6610f2; +} + +.nav-pills .nav-link:not(.active):hover { + color: #6610f2; +} + +#footer .nav .nav-item .nav-link:focus { + color: #6610f2; +} +#footer .nav .nav-link:hover { + color: #6610f2; +} +#footer .footer-copyright .nav .nav-link:hover { + color: #6610f2; +} + +/* Back to Top */ +#back-to-top:hover { + background-color: #6610f2; +} + +/* Extras */ +.bg-primary, .badge-primary { + background-color: #6610f2 !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: #6610f2 !important; +} + +.btn-link:hover { + color: #570bd3 !important; +} + +.text-muted { + color: #8e9a9d !important; +} + +.text-light { + color: #dee3e4 !important; +} + +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover { + background-color: #570bd3 !important; +} + +.border-primary { + border-color: #6610f2 !important; +} + +.btn-primary { + background-color: #6610f2; + border-color: #6610f2; +} +.btn-primary:hover { + background-color: #570bd3; + border-color: #570bd3; +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active { + background-color: #570bd3; + border-color: #570bd3; +} + +.btn-primary.focus, .btn-primary:focus { + background-color: #570bd3; + border-color: #570bd3; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active { + color: #6610f2; + border-color: #6610f2; +} +.btn-outline-primary:hover, .btn-outline-primary:not(:disabled):not(.disabled).active:hover, .btn-outline-primary:not(:disabled):not(.disabled):active:hover { + background-color: #6610f2; + border-color: #6610f2; + color: #fff; +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active { + background-color: #6610f2; +} + +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before { + background-color: #6610f2; + border-color: #6610f2; +} + +.list-group-item.active { + background-color: #6610f2; + border-color: #6610f2; +} + +.page-link { + color: #6610f2; +} +.page-link:hover { + color: #570bd3; +} diff --git a/docs/assets/css/color-orange.css b/docs/assets/css/color-orange.css new file mode 100644 index 00000000..d7cda6ba --- /dev/null +++ b/docs/assets/css/color-orange.css @@ -0,0 +1,159 @@ +/*============================ + COLOR Orange +==============================*/ +::selection { + background: #fd7e14; +} + +a, a:focus { + color: #fd7e14; +} + +a:hover, a:active { + color: #eb6c02; +} + +.primary-menu ul.navbar-nav > li:hover > a:not(.btn), .primary-menu ul.navbar-nav > li > a.active:not(.btn) { + color: #fd7e14; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #fd7e14; +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:not(.btn):after { + border-color: #fd7e14; +} + +/*=== Side Navigation ===*/ +.idocs-navigation .nav .nav .nav-item .nav-link.active:after, .idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link.active:after { + border-color: #fd7e14; +} + +/* Accordion & Toggle */ +.accordion .card-header a:hover.collapsed { + color: #fd7e14 !important; +} +.accordion:not(.accordion-alternate) .card-header a { + background-color: #fd7e14; + color: #fff; +} + +/* Nav */ +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover { + color: #fd7e14; +} + +.nav-tabs .nav-item .nav-link.active { + color: #0c2f55; +} +.nav-tabs .nav-item .nav-link.active:after { + background-color: #fd7e14; +} +.nav-tabs .nav-item .nav-link:not(.active):hover { + color: #fd7e14; +} +.nav-tabs.flex-column .nav-item .nav-link.active { + color: #fd7e14; +} + +.nav-pills .nav-link:not(.active):hover { + color: #fd7e14; +} + +#footer .nav .nav-item .nav-link:focus { + color: #fd7e14; +} +#footer .nav .nav-link:hover { + color: #fd7e14; +} +#footer .footer-copyright .nav .nav-link:hover { + color: #fd7e14; +} + +/* Back to Top */ +#back-to-top:hover { + background-color: #fd7e14; +} + +/* Extras */ +.bg-primary, .badge-primary { + background-color: #fd7e14 !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: #fd7e14 !important; +} + +.btn-link:hover { + color: #eb6c02 !important; +} + +.text-muted { + color: #8e9a9d !important; +} + +.text-light { + color: #dee3e4 !important; +} + +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover { + background-color: #eb6c02 !important; +} + +.border-primary { + border-color: #fd7e14 !important; +} + +.btn-primary { + background-color: #fd7e14; + border-color: #fd7e14; +} +.btn-primary:hover { + background-color: #eb6c02; + border-color: #eb6c02; +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active { + background-color: #eb6c02; + border-color: #eb6c02; +} + +.btn-primary.focus, .btn-primary:focus { + background-color: #eb6c02; + border-color: #eb6c02; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active { + color: #fd7e14; + border-color: #fd7e14; +} +.btn-outline-primary:hover, .btn-outline-primary:not(:disabled):not(.disabled).active:hover, .btn-outline-primary:not(:disabled):not(.disabled):active:hover { + background-color: #fd7e14; + border-color: #fd7e14; + color: #fff; +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active { + background-color: #fd7e14; +} + +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before { + background-color: #fd7e14; + border-color: #fd7e14; +} + +.list-group-item.active { + background-color: #fd7e14; + border-color: #fd7e14; +} + +.page-link { + color: #fd7e14; +} +.page-link:hover { + color: #eb6c02; +} diff --git a/docs/assets/css/color-purple.css b/docs/assets/css/color-purple.css new file mode 100644 index 00000000..f1967393 --- /dev/null +++ b/docs/assets/css/color-purple.css @@ -0,0 +1,159 @@ +/*============================ + COLOR Purple +==============================*/ +::selection { + background: #6f42c1; +} + +a, a:focus { + color: #6f42c1; +} + +a:hover, a:active { + color: #5f37a8; +} + +.primary-menu ul.navbar-nav > li:hover > a:not(.btn), .primary-menu ul.navbar-nav > li > a.active:not(.btn) { + color: #6f42c1; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #6f42c1; +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:not(.btn):after { + border-color: #6f42c1; +} + +/*=== Side Navigation ===*/ +.idocs-navigation .nav .nav .nav-item .nav-link.active:after, .idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link.active:after { + border-color: #6f42c1; +} + +/* Accordion & Toggle */ +.accordion .card-header a:hover.collapsed { + color: #6f42c1 !important; +} +.accordion:not(.accordion-alternate) .card-header a { + background-color: #6f42c1; + color: #fff; +} + +/* Nav */ +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover { + color: #6f42c1; +} + +.nav-tabs .nav-item .nav-link.active { + color: #0c2f55; +} +.nav-tabs .nav-item .nav-link.active:after { + background-color: #6f42c1; +} +.nav-tabs .nav-item .nav-link:not(.active):hover { + color: #6f42c1; +} +.nav-tabs.flex-column .nav-item .nav-link.active { + color: #6f42c1; +} + +.nav-pills .nav-link:not(.active):hover { + color: #6f42c1; +} + +#footer .nav .nav-item .nav-link:focus { + color: #6f42c1; +} +#footer .nav .nav-link:hover { + color: #6f42c1; +} +#footer .footer-copyright .nav .nav-link:hover { + color: #6f42c1; +} + +/* Back to Top */ +#back-to-top:hover { + background-color: #6f42c1; +} + +/* Extras */ +.bg-primary, .badge-primary { + background-color: #6f42c1 !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: #6f42c1 !important; +} + +.btn-link:hover { + color: #5f37a8 !important; +} + +.text-muted { + color: #8e9a9d !important; +} + +.text-light { + color: #dee3e4 !important; +} + +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover { + background-color: #5f37a8 !important; +} + +.border-primary { + border-color: #6f42c1 !important; +} + +.btn-primary { + background-color: #6f42c1; + border-color: #6f42c1; +} +.btn-primary:hover { + background-color: #5f37a8; + border-color: #5f37a8; +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active { + background-color: #5f37a8; + border-color: #5f37a8; +} + +.btn-primary.focus, .btn-primary:focus { + background-color: #5f37a8; + border-color: #5f37a8; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active { + color: #6f42c1; + border-color: #6f42c1; +} +.btn-outline-primary:hover, .btn-outline-primary:not(:disabled):not(.disabled).active:hover, .btn-outline-primary:not(:disabled):not(.disabled):active:hover { + background-color: #6f42c1; + border-color: #6f42c1; + color: #fff; +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active { + background-color: #6f42c1; +} + +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before { + background-color: #6f42c1; + border-color: #6f42c1; +} + +.list-group-item.active { + background-color: #6f42c1; + border-color: #6f42c1; +} + +.page-link { + color: #6f42c1; +} +.page-link:hover { + color: #5f37a8; +} diff --git a/docs/assets/css/color-red.css b/docs/assets/css/color-red.css new file mode 100644 index 00000000..e9d68d6b --- /dev/null +++ b/docs/assets/css/color-red.css @@ -0,0 +1,159 @@ +/*============================ + COLOR Red +==============================*/ +::selection { + background: #dc3545; +} + +a, a:focus { + color: #dc3545; +} + +a:hover, a:active { + color: #ca2333; +} + +.primary-menu ul.navbar-nav > li:hover > a:not(.btn), .primary-menu ul.navbar-nav > li > a.active:not(.btn) { + color: #dc3545; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #dc3545; +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:not(.btn):after { + border-color: #dc3545; +} + +/*=== Side Navigation ===*/ +.idocs-navigation .nav .nav .nav-item .nav-link.active:after, .idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link.active:after { + border-color: #dc3545; +} + +/* Accordion & Toggle */ +.accordion .card-header a:hover.collapsed { + color: #dc3545 !important; +} +.accordion:not(.accordion-alternate) .card-header a { + background-color: #dc3545; + color: #fff; +} + +/* Nav */ +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover { + color: #dc3545; +} + +.nav-tabs .nav-item .nav-link.active { + color: #0c2f55; +} +.nav-tabs .nav-item .nav-link.active:after { + background-color: #dc3545; +} +.nav-tabs .nav-item .nav-link:not(.active):hover { + color: #dc3545; +} +.nav-tabs.flex-column .nav-item .nav-link.active { + color: #dc3545; +} + +.nav-pills .nav-link:not(.active):hover { + color: #dc3545; +} + +#footer .nav .nav-item .nav-link:focus { + color: #dc3545; +} +#footer .nav .nav-link:hover { + color: #dc3545; +} +#footer .footer-copyright .nav .nav-link:hover { + color: #dc3545; +} + +/* Back to Top */ +#back-to-top:hover { + background-color: #dc3545; +} + +/* Extras */ +.bg-primary, .badge-primary { + background-color: #dc3545 !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: #dc3545 !important; +} + +.btn-link:hover { + color: #ca2333 !important; +} + +.text-muted { + color: #8e9a9d !important; +} + +.text-light { + color: #dee3e4 !important; +} + +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover { + background-color: #ca2333 !important; +} + +.border-primary { + border-color: #dc3545 !important; +} + +.btn-primary { + background-color: #dc3545; + border-color: #dc3545; +} +.btn-primary:hover { + background-color: #ca2333; + border-color: #ca2333; +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active { + background-color: #ca2333; + border-color: #ca2333; +} + +.btn-primary.focus, .btn-primary:focus { + background-color: #ca2333; + border-color: #ca2333; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active { + color: #dc3545; + border-color: #dc3545; +} +.btn-outline-primary:hover, .btn-outline-primary:not(:disabled):not(.disabled).active:hover, .btn-outline-primary:not(:disabled):not(.disabled):active:hover { + background-color: #dc3545; + border-color: #dc3545; + color: #fff; +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active { + background-color: #dc3545; +} + +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before { + background-color: #dc3545; + border-color: #dc3545; +} + +.list-group-item.active { + background-color: #dc3545; + border-color: #dc3545; +} + +.page-link { + color: #dc3545; +} +.page-link:hover { + color: #ca2333; +} diff --git a/docs/assets/css/color-teal.css b/docs/assets/css/color-teal.css new file mode 100644 index 00000000..8b8116a7 --- /dev/null +++ b/docs/assets/css/color-teal.css @@ -0,0 +1,159 @@ +/*============================ + COLOR Teal +==============================*/ +::selection { + background: #20c997; +} + +a, a:focus { + color: #20c997; +} + +a:hover, a:active { + color: #1baa80; +} + +.primary-menu ul.navbar-nav > li:hover > a:not(.btn), .primary-menu ul.navbar-nav > li > a.active:not(.btn) { + color: #20c997; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #20c997; +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:not(.btn):after { + border-color: #20c997; +} + +/*=== Side Navigation ===*/ +.idocs-navigation .nav .nav .nav-item .nav-link.active:after, .idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link.active:after { + border-color: #20c997; +} + +/* Accordion & Toggle */ +.accordion .card-header a:hover.collapsed { + color: #20c997 !important; +} +.accordion:not(.accordion-alternate) .card-header a { + background-color: #20c997; + color: #fff; +} + +/* Nav */ +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover { + color: #20c997; +} + +.nav-tabs .nav-item .nav-link.active { + color: #0c2f55; +} +.nav-tabs .nav-item .nav-link.active:after { + background-color: #20c997; +} +.nav-tabs .nav-item .nav-link:not(.active):hover { + color: #20c997; +} +.nav-tabs.flex-column .nav-item .nav-link.active { + color: #20c997; +} + +.nav-pills .nav-link:not(.active):hover { + color: #20c997; +} + +#footer .nav .nav-item .nav-link:focus { + color: #20c997; +} +#footer .nav .nav-link:hover { + color: #20c997; +} +#footer .footer-copyright .nav .nav-link:hover { + color: #20c997; +} + +/* Back to Top */ +#back-to-top:hover { + background-color: #20c997; +} + +/* Extras */ +.bg-primary, .badge-primary { + background-color: #20c997 !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: #20c997 !important; +} + +.btn-link:hover { + color: #1baa80 !important; +} + +.text-muted { + color: #8e9a9d !important; +} + +.text-light { + color: #dee3e4 !important; +} + +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover { + background-color: #1baa80 !important; +} + +.border-primary { + border-color: #20c997 !important; +} + +.btn-primary { + background-color: #20c997; + border-color: #20c997; +} +.btn-primary:hover { + background-color: #1baa80; + border-color: #1baa80; +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active { + background-color: #1baa80; + border-color: #1baa80; +} + +.btn-primary.focus, .btn-primary:focus { + background-color: #1baa80; + border-color: #1baa80; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active { + color: #20c997; + border-color: #20c997; +} +.btn-outline-primary:hover, .btn-outline-primary:not(:disabled):not(.disabled).active:hover, .btn-outline-primary:not(:disabled):not(.disabled):active:hover { + background-color: #20c997; + border-color: #20c997; + color: #fff; +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active { + background-color: #20c997; +} + +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before { + background-color: #20c997; + border-color: #20c997; +} + +.list-group-item.active { + background-color: #20c997; + border-color: #20c997; +} + +.page-link { + color: #20c997; +} +.page-link:hover { + color: #1baa80; +} diff --git a/docs/assets/css/color-yellow.css b/docs/assets/css/color-yellow.css new file mode 100644 index 00000000..6c59cadf --- /dev/null +++ b/docs/assets/css/color-yellow.css @@ -0,0 +1,159 @@ +/*============================ + COLOR Yellow +==============================*/ +::selection { + background: #ffc107; +} + +a, a:focus { + color: #ffc107; +} + +a:hover, a:active { + color: #f7b900; +} + +.primary-menu ul.navbar-nav > li:hover > a:not(.btn), .primary-menu ul.navbar-nav > li > a.active:not(.btn) { + color: #ffc107; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #ffc107; +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:not(.btn):after { + border-color: #ffc107; +} + +/*=== Side Navigation ===*/ +.idocs-navigation .nav .nav .nav-item .nav-link.active:after, .idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link.active:after { + border-color: #ffc107; +} + +/* Accordion & Toggle */ +.accordion .card-header a:hover.collapsed { + color: #ffc107 !important; +} +.accordion:not(.accordion-alternate) .card-header a { + background-color: #ffc107; + color: #fff; +} + +/* Nav */ +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover { + color: #ffc107; +} + +.nav-tabs .nav-item .nav-link.active { + color: #0c2f55; +} +.nav-tabs .nav-item .nav-link.active:after { + background-color: #ffc107; +} +.nav-tabs .nav-item .nav-link:not(.active):hover { + color: #ffc107; +} +.nav-tabs.flex-column .nav-item .nav-link.active { + color: #ffc107; +} + +.nav-pills .nav-link:not(.active):hover { + color: #ffc107; +} + +#footer .nav .nav-item .nav-link:focus { + color: #ffc107; +} +#footer .nav .nav-link:hover { + color: #ffc107; +} +#footer .footer-copyright .nav .nav-link:hover { + color: #ffc107; +} + +/* Back to Top */ +#back-to-top:hover { + background-color: #ffc107; +} + +/* Extras */ +.bg-primary, .badge-primary { + background-color: #ffc107 !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: #ffc107 !important; +} + +.btn-link:hover { + color: #f7b900 !important; +} + +.text-muted { + color: #8e9a9d !important; +} + +.text-light { + color: #dee3e4 !important; +} + +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover { + background-color: #f7b900 !important; +} + +.border-primary { + border-color: #ffc107 !important; +} + +.btn-primary { + background-color: #ffc107; + border-color: #ffc107; +} +.btn-primary:hover { + background-color: #f7b900; + border-color: #f7b900; +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active { + background-color: #f7b900; + border-color: #f7b900; +} + +.btn-primary.focus, .btn-primary:focus { + background-color: #f7b900; + border-color: #f7b900; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active { + color: #ffc107; + border-color: #ffc107; +} +.btn-outline-primary:hover, .btn-outline-primary:not(:disabled):not(.disabled).active:hover, .btn-outline-primary:not(:disabled):not(.disabled):active:hover { + background-color: #ffc107; + border-color: #ffc107; + color: #fff; +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active { + background-color: #ffc107; +} + +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before { + background-color: #ffc107; + border-color: #ffc107; +} + +.list-group-item.active { + background-color: #ffc107; + border-color: #ffc107; +} + +.page-link { + color: #ffc107; +} +.page-link:hover { + color: #f7b900; +} diff --git a/docs/assets/css/stylesheet.css b/docs/assets/css/stylesheet.css new file mode 100644 index 00000000..2d113168 --- /dev/null +++ b/docs/assets/css/stylesheet.css @@ -0,0 +1,2986 @@ +/*=========================================================== + + Template Name: iDocs - One Page Documentation HTML Template + Author: Harnish Design + Template URL: http://demo.harnishdesign.net/html/idocs + Author URL: https://themeforest.net/user/harnishdesign + File Description : Main css file of the template + +================================================= + Table of Contents +================================================= + + 1. Basic + 2. Helpers Classes + 3. Layouts + 3.1 Side Navigation + 3.2 Docs Content + 3.3 Section Divider + 4. Header + 4.1 Main Navigation + 5 Elements + 5.1 List Style + 5.2 Changelog + 5.3 Accordion & Toggle + 5.4 Nav + 5.5 Tabs + 5.6 Popup Img + 5.7 Featured Box + 6 Footer + 6.1 Social Icons + 6.2 Back to Top + 7 Extra + +=======================================================*/ +/* =================================== */ +/* 1. Basic Style +/* =================================== */ +body, html { + height: 100%; +} + +body { + background: #dddddd; + color: #4c4d4d; +} + +/*-------- Preloader --------*/ +.preloader { + position: fixed; + width: 100%; + height: 100%; + z-index: 999999999 !important; + background-color: #fff; + top: 0; + left: 0; + right: 0; + bottom: 0; +} +.preloader .lds-ellipsis { + display: inline-block; + position: absolute; + width: 80px; + height: 80px; + margin-top: -40px; + margin-left: -40px; + top: 50%; + left: 50%; +} +.preloader .lds-ellipsis div { + position: absolute; + top: 33px; + width: 13px; + height: 13px; + border-radius: 50%; + background: #000; + animation-timing-function: cubic-bezier(0, 1, 1, 0); +} +.preloader .lds-ellipsis div:nth-child(1) { + left: 8px; + animation: lds-ellipsis1 0.6s infinite; +} +.preloader .lds-ellipsis div:nth-child(2) { + left: 8px; + animation: lds-ellipsis2 0.6s infinite; +} +.preloader .lds-ellipsis div:nth-child(3) { + left: 32px; + animation: lds-ellipsis2 0.6s infinite; +} +.preloader .lds-ellipsis div:nth-child(4) { + left: 56px; + animation: lds-ellipsis3 0.6s infinite; +} + +@keyframes lds-ellipsis1 { + 0% { + transform: scale(0); + } + 100% { + transform: scale(1); + } +} +@keyframes lds-ellipsis3 { + 0% { + transform: scale(1); + } + 100% { + transform: scale(0); + } +} +@keyframes lds-ellipsis2 { + 0% { + transform: translate(0, 0); + } + 100% { + transform: translate(24px, 0); + } +} +/*--- Preloader Magnific Popup ----*/ +.mfp-container .preloader { + background: transparent; +} +.mfp-container .preloader .lds-ellipsis div { + background: #fff; +} + +::selection { + background: #0366d6; + color: #fff; + text-shadow: none; +} + +code { + padding: 2px 5px; + background-color: #f9f2f4; + border-radius: 4px; +} + +form { + padding: 0; + margin: 0; + display: inline; +} + +img { + vertical-align: inherit; +} + +a, a:focus { + color: #0366d6; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} + +a:hover, a:active { + color: #0355b3; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} + +a:focus, a:active, +.btn.active.focus, +.btn.active:focus, +.btn.focus, +.btn:active.focus, +.btn:active:focus, +.btn:focus, +button:focus, +button:active { + outline: none; +} + +p { + line-height: 1.8; +} + +blockquote { + border-left: 5px solid #eee; + padding: 10px 20px; +} + +iframe { + border: 0 !important; +} + +h1, h2, h3, h4, h5, h6 { + color: #252b33; + line-height: 1.5; + margin: 0 0 1.5rem 0; + font-family: Roboto, sans-serif; +} + +h1 { + font-size: 3rem; +} + +h2 { + font-size: 2.2rem; +} + +dl, ol, ul, pre, blockquote, .table { + margin-bottom: 1.8rem; +} + +/*=== Highlight Js ===*/ +.hljs { + padding: 1.5rem; +} + +/* =================================== */ +/* 2. Helpers Classes +/* =================================== */ +/* Box Shadow */ +.shadow-md { + -webkit-box-shadow: 0px 0px 50px -35px rgba(0, 0, 0, 0.4) !important; + box-shadow: 0px 0px 50px -35px rgba(0, 0, 0, 0.4) !important; +} + +/* Border Radius */ +.rounded-lg { + border-radius: 0.6rem !important; +} + +.rounded-top-0 { + border-top-left-radius: 0px !important; + border-top-right-radius: 0px !important; +} + +.rounded-bottom-0 { + border-bottom-left-radius: 0px !important; + border-bottom-right-radius: 0px !important; +} + +.rounded-left-0 { + border-top-left-radius: 0px !important; + border-bottom-left-radius: 0px !important; +} + +.rounded-right-0 { + border-top-right-radius: 0px !important; + border-bottom-right-radius: 0px !important; +} + +/* Border Size */ +.border-1 { + border-width: 1px !important; +} + +.border-2 { + border-width: 2px !important; +} + +.border-3 { + border-width: 3px !important; +} + +.border-4 { + border-width: 4px !important; +} + +.border-5 { + border-width: 5px !important; +} + +/* Text Size */ +.text-0 { + font-size: 11px !important; + font-size: 0.6875rem !important; +} + +.text-1 { + font-size: 12px !important; + font-size: 0.75rem !important; +} + +.text-2 { + font-size: 14px !important; + font-size: 0.875rem !important; +} + +.text-3 { + font-size: 16px !important; + font-size: 1rem !important; +} + +.text-4 { + font-size: 18px !important; + font-size: 1.125rem !important; +} + +.text-5 { + font-size: 21px !important; + font-size: 1.3125rem !important; +} + +.text-6 { + font-size: 24px !important; + font-size: 1.50rem !important; +} + +.text-7 { + font-size: 28px !important; + font-size: 1.75rem !important; +} + +.text-8 { + font-size: 32px !important; + font-size: 2rem !important; +} + +.text-9 { + font-size: 36px !important; + font-size: 2.25rem !important; +} + +.text-10 { + font-size: 40px !important; + font-size: 2.50rem !important; +} + +.text-11 { + font-size: 2.75rem !important; +} +@media (max-width: 992px) { + .text-11 { + font-size: calc(1.4rem + 2.1774193548vw) !important; + } +} + +.text-12 { + font-size: 3rem !important; +} +@media (max-width: 992px) { + .text-12 { + font-size: calc(1.425rem + 2.5403225806vw) !important; + } +} + +.text-13 { + font-size: 3.25rem !important; +} +@media (max-width: 992px) { + .text-13 { + font-size: calc(1.45rem + 2.9032258065vw) !important; + } +} + +.text-14 { + font-size: 3.5rem !important; +} +@media (max-width: 992px) { + .text-14 { + font-size: calc(1.475rem + 3.2661290323vw) !important; + } +} + +.text-15 { + font-size: 3.75rem !important; +} +@media (max-width: 992px) { + .text-15 { + font-size: calc(1.5rem + 3.6290322581vw) !important; + } +} + +.text-16 { + font-size: 4rem !important; +} +@media (max-width: 992px) { + .text-16 { + font-size: calc(1.525rem + 3.9919354839vw) !important; + } +} + +.text-17 { + font-size: 4.5rem !important; +} +@media (max-width: 992px) { + .text-17 { + font-size: calc(1.575rem + 4.7177419355vw) !important; + } +} + +.text-18 { + font-size: 5rem !important; +} +@media (max-width: 992px) { + .text-18 { + font-size: calc(1.625rem + 5.4435483871vw) !important; + } +} + +.text-19 { + font-size: 5.25rem !important; +} +@media (max-width: 992px) { + .text-19 { + font-size: calc(1.65rem + 5.8064516129vw) !important; + } +} + +.text-20 { + font-size: 5.75rem !important; +} +@media (max-width: 992px) { + .text-20 { + font-size: calc(1.7rem + 6.5322580645vw) !important; + } +} + +.text-21 { + font-size: 6.5rem !important; +} +@media (max-width: 992px) { + .text-21 { + font-size: calc(1.775rem + 7.6209677419vw) !important; + } +} + +.text-22 { + font-size: 7rem !important; +} +@media (max-width: 992px) { + .text-22 { + font-size: calc(1.825rem + 8.3467741935vw) !important; + } +} + +.text-23 { + font-size: 7.75rem !important; +} +@media (max-width: 992px) { + .text-23 { + font-size: calc(1.9rem + 9.435483871vw) !important; + } +} + +.text-24 { + font-size: 8.25rem !important; +} +@media (max-width: 992px) { + .text-24 { + font-size: calc(1.95rem + 10.1612903226vw) !important; + } +} + +.text-25 { + font-size: 9rem !important; +} +@media (max-width: 992px) { + .text-25 { + font-size: calc(2.025rem + 11.25vw) !important; + } +} + +.text-11, .text-12, .text-13, .text-14, .text-15, .text-16, .text-17, .text-18, .text-19, .text-20, .text-21, .text-22, .text-23, .text-24, .text-25 { + line-height: 1.3; +} + +/* Line height */ +.line-height-07 { + line-height: 0.7 !important; +} + +.line-height-1 { + line-height: 1 !important; +} + +.line-height-2 { + line-height: 1.2 !important; +} + +.line-height-3 { + line-height: 1.4 !important; +} + +.line-height-4 { + line-height: 1.6 !important; +} + +.line-height-5 { + line-height: 1.8 !important; +} + +/* Font Weight */ +.font-weight-100 { + font-weight: 100 !important; +} + +.font-weight-200 { + font-weight: 200 !important; +} + +.font-weight-300 { + font-weight: 300 !important; +} + +.font-weight-400 { + font-weight: 400 !important; +} + +.font-weight-500 { + font-weight: 500 !important; +} + +.font-weight-600 { + font-weight: 600 !important; +} + +.font-weight-700 { + font-weight: 700 !important; +} + +.font-weight-800 { + font-weight: 800 !important; +} + +.font-weight-900 { + font-weight: 900 !important; +} + +/* Opacity */ +.opacity-0 { + opacity: 0; +} + +.opacity-1 { + opacity: 0.1; +} + +.opacity-2 { + opacity: 0.2; +} + +.opacity-3 { + opacity: 0.3; +} + +.opacity-4 { + opacity: 0.4; +} + +.opacity-5 { + opacity: 0.5; +} + +.opacity-6 { + opacity: 0.6; +} + +.opacity-7 { + opacity: 0.7; +} + +.opacity-8 { + opacity: 0.8; +} + +.opacity-9 { + opacity: 0.9; +} + +.opacity-10 { + opacity: 1; +} + +/* Background light */ +.bg-light-1 { + background-color: #e9ecef !important; +} + +.bg-light-2 { + background-color: #dee2e6 !important; +} + +.bg-light-3 { + background-color: #ced4da !important; +} + +.bg-light-4 { + background-color: #adb5bd !important; +} + +/* Background Dark */ +.bg-dark { + background-color: #111418 !important; +} + +.bg-dark-1 { + background-color: #212529 !important; +} + +.bg-dark-2 { + background-color: #343a40 !important; +} + +.bg-dark-3 { + background-color: #495057 !important; +} + +.bg-dark-4 { + background-color: #6c757d !important; +} + +/* Progress Bar */ +.progress-sm { + height: 0.5rem !important; +} + +.progress-lg { + height: 1.5rem !important; +} + +hr { + border-top: 1px solid rgba(16, 85, 96, 0.1); +} + +/* =================================== */ +/* 3. Layouts +/* =================================== */ +#main-wrapper { + background: #fff; +} + +.box #main-wrapper { + max-width: 1200px; + margin: 0 auto; + -webkit-box-shadow: 0px 0px 10px rgba(0, 0, 0, 0.1); + box-shadow: 0px 0px 10px rgba(0, 0, 0, 0.1); +} +.box .idocs-navigation { + left: auto; +} + +@media (min-width: 1200px) { + .container { + max-width: 1170px !important; + } +} +/*=== 3.1 Side Navigation ===*/ +.idocs-navigation { + position: fixed; + top: 70px; + left: 0; + overflow: hidden; + overflow-y: auto; + width: 260px; + height: calc(100% - 70px); + z-index: 1; + border-right: 1px solid rgba(0, 0, 0, 0.05); + transition: all 0.3s; +} +.idocs-navigation > .nav { + padding: 30px 0; +} +.idocs-navigation .nav .nav-item { + position: relative; +} +.idocs-navigation .nav .nav { + margin: 0 0 5px; +} +.idocs-navigation .nav .nav-link { + position: relative; + padding: 6px 30px; + line-height: 25px; + font-weight: 600; +} +.idocs-navigation .nav .nav-item:hover > .nav-link, .idocs-navigation .nav .nav-item .nav-link.active { + font-weight: 700; +} +.idocs-navigation .nav .nav { + display: none; + border-left: 1px solid regba(0, 0, 0, 0.3); +} +.idocs-navigation .nav .nav .nav-item .nav-link:after { + content: ""; + position: absolute; + left: 30px; + height: 100%; + border-left: 1px solid rgba(0, 0, 0, 0.12); + width: 1px; + top: 0; +} +.idocs-navigation .nav .nav .nav-item .nav-link.active:after { + border-color: #0366d6; + border-width: 2px; +} +.idocs-navigation .nav .nav-item .nav-link.active + .nav { + display: block; +} +.idocs-navigation .nav .nav .nav-link { + color: #6a6a6a; + padding: 4px 30px 4px 45px; + font-size: 15px; + text-transform: none; +} +.idocs-navigation .nav .nav .nav .nav-link { + padding: 4px 30px 4px 60px; + font-size: 15px; +} +.idocs-navigation .nav .nav .nav .nav-item .nav-link:after { + left: 45px; +} +.idocs-navigation > .nav > .nav-item > .nav-link.active:after { + position: absolute; + content: " "; + top: 50%; + right: 18px; + border-color: #000; + border-top: 2px solid; + border-right: 2px solid; + width: 7px; + height: 7px; + -webkit-transform: translate(-50%, -50%) rotate(45deg); + transform: translate(-50%, -50%) rotate(45deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +.idocs-navigation.docs-navigation-dark .nav .nav-link { + color: rgba(250, 250, 250, 0.85); +} +.idocs-navigation.docs-navigation-dark .nav .nav .nav-link { + color: rgba(250, 250, 250, 0.7); +} +.idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link:after { + border-color: rgba(250, 250, 250, 0.2); +} +.idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link.active:after { + border-color: #0366d6; +} + +/*=== 3.2 Docs Content ===*/ +.idocs-content { + position: relative; + margin-left: 260px; + padding: 0px 50px 50px; + min-height: 750px; + transition: all 0.3s; +} +.idocs-content section:first-child { + padding-top: 3rem; +} +.idocs-content ol li, .idocs-content ul li { + margin-top: 10px; +} + +@media (max-width: 767.98px) { + .idocs-navigation { + margin-left: -260px; + } + .idocs-navigation.active { + margin-left: 0; + } + + .idocs-content { + margin-left: 0px; + padding: 0px; + } +} +/*=== 3.3 Section Divider ===*/ +.divider { + margin: 4rem 0; +} + +/* =================================== */ +/* 4. Header +/* =================================== */ +#header { + -webkit-transition: all 0.5s ease; + transition: all 0.5s ease; +} +#header .navbar { + padding: 0px; + min-height: 70px; +} +#header .logo { + -webkit-box-align: center; + -ms-flex-align: center; + align-items: center; + display: -webkit-box; + display: -ms-flexbox; + display: flex; + -ms-flex-item-align: stretch; + align-self: stretch; +} + +/*=== 4.1 Main Navigation ===*/ +.navbar-light .navbar-nav .active > .nav-link { + color: #0c2f55; +} +.navbar-light .navbar-nav .nav-link.active, .navbar-light .navbar-nav .nav-link.show { + color: #0c2f55; +} +.navbar-light .navbar-nav .show > .nav-link { + color: #0c2f55; +} + +.primary-menu { + display: -webkit-box !important; + display: -ms-flexbox !important; + display: flex !important; + height: auto !important; + -webkit-box-ordinal-group: 0; + -ms-flex-item-align: stretch; + align-self: stretch; + background: #fff; + border-bottom: 1px solid #efefef; +} +.primary-menu.bg-transparent { + position: absolute; + z-index: 999; + top: 0; + left: 0; + width: 100%; + box-shadow: none; + border-bottom: 1px solid rgba(250, 250, 250, 0.3); +} +.primary-menu.sticky-on { + position: fixed; + top: 0; + width: 100%; + z-index: 1020; + left: 0; + -webkit-box-shadow: 0px 0px 10px rgba(0, 0, 0, 0.05); + box-shadow: 0px 0px 10px rgba(0, 0, 0, 0.05); + -webkit-animation: slide-down 0.7s; + -moz-animation: slide-down 0.7s; + animation: slide-down 0.7s; +} +@-webkit-keyframes slide-down { + 0% { + opacity: 0; + transform: translateY(-100%); + } + 100% { + opacity: 1; + transform: translateY(0); + } +} +@-moz-keyframes slide-down { + 0% { + opacity: 0; + transform: translateY(-100%); + } + 100% { + opacity: 1; + transform: translateY(0); + } +} +@keyframes slide-down { + 0% { + opacity: 0; + transform: translateY(-100%); + } + 100% { + opacity: 1; + transform: translateY(0); + } +} +.primary-menu.sticky-on .none-on-sticky { + display: none !important; +} +.primary-menu ul.navbar-nav > li { + display: -webkit-box; + display: -ms-flexbox; + display: flex; + height: 100%; +} +.primary-menu ul.navbar-nav > li + li { + margin-left: 2px; +} +.primary-menu ul.navbar-nav > li a { + display: -webkit-box; + display: -ms-flexbox; + display: flex; + -webkit-box-align: center; + -ms-flex-align: center; + align-items: center; +} +.primary-menu ul.navbar-nav > li > a:not(.btn) { + height: 70px; + padding: 0px 0.85em; + color: #252b33; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + position: relative; + position: relative; +} +.primary-menu ul.navbar-nav > li:hover > a:not(.btn), .primary-menu ul.navbar-nav > li > a.active:not(.btn) { + color: #0366d6; + text-decoration: none; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +.primary-menu ul.navbar-nav > li a.btn { + padding: 0.4rem 1.4rem; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li > a:not(.btn) { + padding: 8px 0px; + background-color: transparent; + text-transform: none; + color: #777; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #0366d6; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +.primary-menu ul.navbar-nav > li.dropdown:hover > a:after { + clear: both; + content: ' '; + display: block; + width: 0; + height: 0; + border-style: solid; + border-color: transparent transparent #fff transparent; + position: absolute; + border-width: 0px 7px 6px 7px; + bottom: 0px; + left: 50%; + margin: 0 0 0 -5px; + z-index: 1022; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu { + -webkit-box-shadow: 0px 0px 12px rgba(0, 0, 0, 0.176); + box-shadow: 0px 0px 12px rgba(0, 0, 0, 0.176); + border: 0px none; + padding: 10px 15px; + min-width: 220px; + margin: 0; + font-size: 14px; + font-size: 0.875rem; + z-index: 1021; +} +.primary-menu ul.navbar-nav > li.dropdown > .dropdown-toggle .arrow { + display: none; +} +.primary-menu .dropdown-menu-right { + left: auto !important; + right: 100% !important; +} +.primary-menu ul.navbar-nav > li.dropdown-mega { + position: static; +} +.primary-menu ul.navbar-nav > li.dropdown-mega > .dropdown-menu { + width: 100%; + padding: 20px 20px; + margin-left: 0px !important; +} +.primary-menu ul.navbar-nav > li.dropdown-mega .dropdown-mega-content > .row > div { + padding: 5px 5px 5px 20px; + border-right: 1px solid #eee; +} +.primary-menu ul.navbar-nav > li.dropdown-mega .dropdown-mega-content > .row > div:last-child { + border-right: 0; +} +.primary-menu ul.navbar-nav > li.dropdown-mega .sub-title { + display: block; + font-size: 16px; + margin-top: 1rem; + padding-bottom: 5px; +} +.primary-menu ul.navbar-nav > li.dropdown-mega .dropdown-mega-submenu { + list-style-type: none; + padding-left: 0px; +} +.primary-menu ul.navbar-nav > li a.btn { + font-size: 14px; + padding: 0.65rem 2rem; + text-transform: uppercase; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + left: 100%; + margin-top: -40px; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-toggle:after { + border-top: .4em solid transparent; + border-right: 0; + border-bottom: 0.4em solid transparent; + border-left: 0.4em solid; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-toggle .arrow { + position: absolute; + min-width: 30px; + height: 100%; + right: 0px; + top: 0; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-toggle .arrow:after { + content: " "; + position: absolute; + top: 50%; + left: 50%; + border-color: #000; + border-top: 1px solid; + border-right: 1px solid; + width: 6px; + height: 6px; + -webkit-transform: translate(-50%, -50%) rotate(45deg); + transform: translate(-50%, -50%) rotate(45deg); +} +.primary-menu .dropdown-toggle:after { + content: none; +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:not(.btn):after { + position: absolute; + content: ""; + height: 2px; + width: 0; + left: 50%; + right: 0; + bottom: 14px; + background-color: transparent; + color: #fff; + border-bottom: 2px solid #0366d6; + -webkit-transition: all 0.3s ease-in-out; + transition: all 0.3s ease-in-out; + transform: translate(-50%, 0) translateZ(0); + -webkit-transform: translate(-50%, 0) translateZ(0); +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:hover:not(.logo):after, .primary-menu.navbar-line-under-text ul.navbar-nav > li > a.active:after { + width: calc(100% - 0.99em); +} + +/*== Color Options ==*/ +.primary-menu.navbar-text-light .navbar-toggler span { + background: #fff; +} + +.primary-menu.navbar-text-light .navbar-nav > li > a:not(.btn) { + color: #fff; +} +.primary-menu.navbar-text-light .navbar-nav > li:hover > a:not(.btn), .primary-menu.navbar-text-light .navbar-nav > li > a.active:not(.btn) { + color: rgba(250, 250, 250, 0.75); +} + +.primary-menu.navbar-text-light.navbar-line-under-text .navbar-nav > li > a:not(.logo):after, .primary-menu.navbar-text-light.navbar-line-under-text .navbar-nav > li > a.active:after { + border-color: rgba(250, 250, 250, 0.6); +} + +.primary-menu.navbar-dropdown-dark ul.navbar-nav > li.dropdown .dropdown-menu { + background-color: #252A2C; + color: #fff; +} +.primary-menu.navbar-dropdown-dark ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + background-color: #272c2e; +} +.primary-menu.navbar-dropdown-dark ul.navbar-nav > li.dropdown:hover > a:after { + border-color: transparent transparent #252A2C transparent; +} +.primary-menu.navbar-dropdown-dark ul.navbar-nav > li.dropdown .dropdown-menu li > a:not(.btn) { + color: rgba(250, 250, 250, 0.8); +} +.primary-menu.navbar-dropdown-dark ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #fafafa; + font-weight: 600; +} +.primary-menu.navbar-dropdown-dark ul.navbar-nav > li.dropdown-mega .dropdown-mega-content > .row > div { + border-color: #3a3a3a; +} +.primary-menu.navbar-dropdown-primary ul.navbar-nav > li.dropdown .dropdown-menu { + background-color: #0366d6; + color: #fff; +} +.primary-menu.navbar-dropdown-primary ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + background-color: #0366d6; +} +.primary-menu.navbar-dropdown-primary ul.navbar-nav > li.dropdown:hover > a:after { + border-color: transparent transparent #0366d6 transparent; +} +.primary-menu.navbar-dropdown-primary ul.navbar-nav > li.dropdown .dropdown-menu li > a:not(.btn) { + color: rgba(250, 250, 250, 0.95); +} +.primary-menu.navbar-dropdown-primary ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #fafafa; + font-weight: 600; +} +.primary-menu.navbar-dropdown-primary ul.navbar-nav > li.dropdown-mega .dropdown-mega-content > .row > div { + border-color: rgba(250, 250, 250, 0.2); +} + +/* Hamburger Menu Button */ +.navbar-toggler { + width: 25px; + height: 30px; + padding: 10px; + margin: 18px 15px; + position: relative; + border: none; + -webkit-transform: rotate(0deg); + transform: rotate(0deg); + -webkit-transition: 0.5s ease-in-out; + transition: 0.5s ease-in-out; + cursor: pointer; + display: block; +} +.navbar-toggler span { + display: block; + position: absolute; + height: 2px; + width: 100%; + background: #3c3636; + border-radius: 2px; + opacity: 1; + left: 0; + -webkit-transform: rotate(0deg); + transform: rotate(0deg); + -webkit-transition: 0.25s ease-in-out; + transition: 0.25s ease-in-out; +} +.navbar-toggler span:nth-child(1) { + top: 7px; + -webkit-transform-origin: left center; + -moz-transform-origin: left center; + -o-transform-origin: left center; + transform-origin: left center; +} +.navbar-toggler span:nth-child(2) { + top: 14px; + -webkit-transform-origin: left center; + -moz-transform-origin: left center; + -o-transform-origin: left center; + transform-origin: left center; +} +.navbar-toggler span:nth-child(3) { + top: 21px; + -webkit-transform-origin: left center; + -moz-transform-origin: left center; + -o-transform-origin: left center; + transform-origin: left center; +} +.navbar-toggler.show span:nth-child(1) { + top: 4px; + left: 3px; + -webkit-transform: rotate(45deg); + transform: rotate(45deg); +} +.navbar-toggler.show span:nth-child(2) { + width: 0%; + opacity: 0; +} +.navbar-toggler.show span:nth-child(3) { + top: 22px; + left: 3px; + -webkit-transform: rotate(-45deg); + transform: rotate(-45deg); +} + +.navbar-accordion { + position: initial; +} + +.navbar-expand-none .navbar-collapse { + position: absolute; + top: 99%; + right: 0; + left: 0; + background: #fff; + margin-top: 0px; + z-index: 1000; + -webkit-box-shadow: 0px 0px 15px rgba(0, 0, 0, 0.1); + box-shadow: 0px 0px 15px rgba(0, 0, 0, 0.1); +} +.navbar-expand-none .navbar-collapse .navbar-nav { + overflow: hidden; + overflow-y: auto; + max-height: 65vh; + padding: 15px; +} +.navbar-expand-none ul.navbar-nav li { + display: block; + border-bottom: 1px solid #eee; + margin: 0; + padding: 0; +} +.navbar-expand-none ul.navbar-nav li:last-child { + border: none; +} +.navbar-expand-none ul.navbar-nav li + li { + margin-left: 0px; +} +.navbar-expand-none ul.navbar-nav li.dropdown > .dropdown-toggle > .arrow.show:after { + -webkit-transform: translate(-50%, -50%) rotate(-45deg); + transform: translate(-50%, -50%) rotate(-45deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +.navbar-expand-none ul.navbar-nav li > a:hover:after, .navbar-expand-none ul.navbar-nav li > a.active:after { + content: none !important; + width: 0px !important; +} +.navbar-expand-none ul.navbar-nav li.dropdown > .dropdown-toggle .arrow { + display: block; +} +.navbar-expand-none ul.navbar-nav > li > a:not(.btn) { + height: auto; + padding: 8px 0; + position: relative; +} +.navbar-expand-none ul.navbar-nav > li.dropdown .dropdown-menu li > a:not(.btn) { + padding: 8px 0; + position: relative; +} +.navbar-expand-none ul.navbar-nav > li.dropdown:hover > a:after { + content: none; +} +.navbar-expand-none ul.navbar-nav > li.dropdown .dropdown-toggle .arrow:after { + -webkit-transform: translate(-50%, -50%) rotate(134deg); + transform: translate(-50%, -50%) rotate(134deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +.navbar-expand-none ul.navbar-nav > li.dropdown .dropdown-menu { + margin: 0; + -webkit-box-shadow: none; + box-shadow: none; + border: none; + padding: 0px 0px 0px 15px; +} +.navbar-expand-none ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + margin: 0; +} +.navbar-expand-none ul.navbar-nav > li.dropdown-mega .dropdown-mega-content > .row > div { + padding: 0px 15px; +} +.navbar-expand-none.navbar-text-light .navbar-collapse { + background: rgba(0, 0, 0, 0.95); +} +.navbar-expand-none.navbar-text-light .navbar-collapse ul.navbar-nav li { + border-color: rgba(250, 250, 250, 0.15); +} +.navbar-expand-none.navbar-dropdown-dark .navbar-collapse { + background-color: #252A2C; +} +.navbar-expand-none.navbar-dropdown-primary .navbar-collapse { + background-color: #0366d6; +} +.navbar-expand-none.navbar-dropdown-primary ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + background-color: #0366d6; +} +.navbar-expand-none.navbar-dropdown-dark ul.navbar-nav li { + border-color: #444; +} +.navbar-expand-none.navbar-dropdown-dark ul.navbar-nav > li > a { + color: #a3a2a2; +} +.navbar-expand-none.navbar-dropdown-dark ul.navbar-nav > li:hover > a { + color: #fff; +} +.navbar-expand-none.navbar-dropdown-primary ul.navbar-nav li { + border-color: rgba(250, 250, 250, 0.2); +} +.navbar-expand-none.navbar-dropdown-primary ul.navbar-nav > li > a { + color: rgba(250, 250, 250, 0.8); +} +.navbar-expand-none.navbar-dropdown-primary ul.navbar-nav > li:hover > a { + color: #fff; +} + +@media (max-width: 575.98px) { + .navbar-expand-sm .navbar-collapse { + position: absolute; + top: 99%; + right: 0; + left: 0; + background: #fff; + margin-top: 0px; + z-index: 1000; + -webkit-box-shadow: 0px 0px 15px rgba(0, 0, 0, 0.1); + box-shadow: 0px 0px 15px rgba(0, 0, 0, 0.1); + } + .navbar-expand-sm .navbar-collapse .navbar-nav { + overflow: hidden; + overflow-y: auto; + max-height: 65vh; + padding: 15px; + } + .navbar-expand-sm ul.navbar-nav li { + display: block; + border-bottom: 1px solid #eee; + margin: 0; + padding: 0; + } + .navbar-expand-sm ul.navbar-nav li:last-child { + border: none; + } + .navbar-expand-sm ul.navbar-nav li + li { + margin-left: 0px; + } + .navbar-expand-sm ul.navbar-nav li.dropdown > .dropdown-toggle > .arrow.show:after { + -webkit-transform: translate(-50%, -50%) rotate(-45deg); + transform: translate(-50%, -50%) rotate(-45deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + } + .navbar-expand-sm ul.navbar-nav li > a:hover:after, .navbar-expand-sm ul.navbar-nav li > a.active:after { + content: none !important; + width: 0px !important; + } + .navbar-expand-sm ul.navbar-nav li.dropdown > .dropdown-toggle .arrow { + display: block; + } + .navbar-expand-sm ul.navbar-nav > li > a:not(.btn) { + height: auto; + padding: 8px 0; + position: relative; + } + .navbar-expand-sm ul.navbar-nav > li.dropdown .dropdown-menu li > a:not(.btn) { + padding: 8px 0; + position: relative; + } + .navbar-expand-sm ul.navbar-nav > li.dropdown:hover > a:after { + content: none; + } + .navbar-expand-sm ul.navbar-nav > li.dropdown .dropdown-toggle .arrow:after { + -webkit-transform: translate(-50%, -50%) rotate(134deg); + transform: translate(-50%, -50%) rotate(134deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + } + .navbar-expand-sm ul.navbar-nav > li.dropdown .dropdown-menu { + margin: 0; + -webkit-box-shadow: none; + box-shadow: none; + border: none; + padding: 0px 0px 0px 15px; + } + .navbar-expand-sm ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + margin: 0; + } + .navbar-expand-sm ul.navbar-nav > li.dropdown-mega .dropdown-mega-content > .row > div { + padding: 0px 15px; + } + .navbar-expand-sm.navbar-text-light .navbar-collapse { + background: rgba(0, 0, 0, 0.95); + } + .navbar-expand-sm.navbar-text-light .navbar-collapse ul.navbar-nav li { + border-color: rgba(250, 250, 250, 0.15); + } + .navbar-expand-sm.navbar-dropdown-dark .navbar-collapse { + background-color: #252A2C; + } + .navbar-expand-sm.navbar-dropdown-primary .navbar-collapse { + background-color: #0366d6; + } + .navbar-expand-sm.navbar-dropdown-primary ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + background-color: #0366d6; + } + .navbar-expand-sm.navbar-dropdown-dark ul.navbar-nav li { + border-color: #444; + } + .navbar-expand-sm.navbar-dropdown-dark ul.navbar-nav > li > a { + color: #a3a2a2; + } + .navbar-expand-sm.navbar-dropdown-dark ul.navbar-nav > li:hover > a { + color: #fff; + } + .navbar-expand-sm.navbar-dropdown-primary ul.navbar-nav li { + border-color: rgba(250, 250, 250, 0.2); + } + .navbar-expand-sm.navbar-dropdown-primary ul.navbar-nav > li > a { + color: rgba(250, 250, 250, 0.8); + } + .navbar-expand-sm.navbar-dropdown-primary ul.navbar-nav > li:hover > a { + color: #fff; + } +} +@media (max-width: 767.98px) { + .navbar-expand-md .navbar-collapse { + position: absolute; + top: 99%; + right: 0; + left: 0; + background: #fff; + margin-top: 0px; + z-index: 1000; + -webkit-box-shadow: 0px 0px 15px rgba(0, 0, 0, 0.1); + box-shadow: 0px 0px 15px rgba(0, 0, 0, 0.1); + } + .navbar-expand-md .navbar-collapse .navbar-nav { + overflow: hidden; + overflow-y: auto; + max-height: 65vh; + padding: 15px; + } + .navbar-expand-md ul.navbar-nav li { + display: block; + border-bottom: 1px solid #eee; + margin: 0; + padding: 0; + } + .navbar-expand-md ul.navbar-nav li:last-child { + border: none; + } + .navbar-expand-md ul.navbar-nav li + li { + margin-left: 0px; + } + .navbar-expand-md ul.navbar-nav li.dropdown > .dropdown-toggle > .arrow.show:after { + -webkit-transform: translate(-50%, -50%) rotate(-45deg); + transform: translate(-50%, -50%) rotate(-45deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + } + .navbar-expand-md ul.navbar-nav li > a:hover:after, .navbar-expand-md ul.navbar-nav li > a.active:after { + content: none !important; + width: 0px !important; + } + .navbar-expand-md ul.navbar-nav li.dropdown > .dropdown-toggle .arrow { + display: block; + } + .navbar-expand-md ul.navbar-nav > li > a:not(.btn) { + height: auto; + padding: 8px 0; + position: relative; + } + .navbar-expand-md ul.navbar-nav > li.dropdown .dropdown-menu li > a:not(.btn) { + padding: 8px 0; + position: relative; + } + .navbar-expand-md ul.navbar-nav > li.dropdown:hover > a:after { + content: none; + } + .navbar-expand-md ul.navbar-nav > li.dropdown .dropdown-toggle .arrow:after { + -webkit-transform: translate(-50%, -50%) rotate(134deg); + transform: translate(-50%, -50%) rotate(134deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + } + .navbar-expand-md ul.navbar-nav > li.dropdown .dropdown-menu { + margin: 0; + -webkit-box-shadow: none; + box-shadow: none; + border: none; + padding: 0px 0px 0px 15px; + } + .navbar-expand-md ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + margin: 0; + } + .navbar-expand-md ul.navbar-nav > li.dropdown-mega .dropdown-mega-content > .row > div { + padding: 0px 15px; + } + .navbar-expand-md.navbar-text-light .navbar-collapse { + background: rgba(0, 0, 0, 0.95); + } + .navbar-expand-md.navbar-text-light .navbar-collapse ul.navbar-nav li { + border-color: rgba(250, 250, 250, 0.15); + } + .navbar-expand-md.navbar-dropdown-dark .navbar-collapse { + background-color: #252A2C; + } + .navbar-expand-md.navbar-dropdown-primary .navbar-collapse { + background-color: #0366d6; + } + .navbar-expand-md.navbar-dropdown-primary ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + background-color: #0366d6; + } + .navbar-expand-md.navbar-dropdown-dark ul.navbar-nav li { + border-color: #444; + } + .navbar-expand-md.navbar-dropdown-dark ul.navbar-nav > li > a { + color: #a3a2a2; + } + .navbar-expand-md.navbar-dropdown-dark ul.navbar-nav > li:hover > a { + color: #fff; + } + .navbar-expand-md.navbar-dropdown-primary ul.navbar-nav li { + border-color: rgba(250, 250, 250, 0.2); + } + .navbar-expand-md.navbar-dropdown-primary ul.navbar-nav > li > a { + color: rgba(250, 250, 250, 0.8); + } + .navbar-expand-md.navbar-dropdown-primary ul.navbar-nav > li:hover > a { + color: #fff; + } +} +@media (max-width: 991.98px) { + .navbar-expand-lg .navbar-collapse { + position: absolute; + top: 99%; + right: 0; + left: 0; + background: #fff; + margin-top: 0px; + z-index: 1000; + -webkit-box-shadow: 0px 0px 15px rgba(0, 0, 0, 0.1); + box-shadow: 0px 0px 15px rgba(0, 0, 0, 0.1); + } + .navbar-expand-lg .navbar-collapse .navbar-nav { + overflow: hidden; + overflow-y: auto; + max-height: 65vh; + padding: 15px; + } + .navbar-expand-lg ul.navbar-nav li { + display: block; + border-bottom: 1px solid #eee; + margin: 0; + padding: 0; + } + .navbar-expand-lg ul.navbar-nav li:last-child { + border: none; + } + .navbar-expand-lg ul.navbar-nav li + li { + margin-left: 0px; + } + .navbar-expand-lg ul.navbar-nav li.dropdown > .dropdown-toggle > .arrow.show:after { + -webkit-transform: translate(-50%, -50%) rotate(-45deg); + transform: translate(-50%, -50%) rotate(-45deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + } + .navbar-expand-lg ul.navbar-nav li > a:hover:after, .navbar-expand-lg ul.navbar-nav li > a.active:after { + content: none !important; + width: 0px !important; + } + .navbar-expand-lg ul.navbar-nav li.dropdown > .dropdown-toggle .arrow { + display: block; + } + .navbar-expand-lg ul.navbar-nav > li > a:not(.btn) { + height: auto; + padding: 8px 0; + position: relative; + } + .navbar-expand-lg ul.navbar-nav > li.dropdown .dropdown-menu li > a:not(.btn) { + padding: 8px 0; + position: relative; + } + .navbar-expand-lg ul.navbar-nav > li.dropdown:hover > a:after { + content: none; + } + .navbar-expand-lg ul.navbar-nav > li.dropdown .dropdown-toggle .arrow:after { + -webkit-transform: translate(-50%, -50%) rotate(134deg); + transform: translate(-50%, -50%) rotate(134deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + } + .navbar-expand-lg ul.navbar-nav > li.dropdown .dropdown-menu { + margin: 0; + -webkit-box-shadow: none; + box-shadow: none; + border: none; + padding: 0px 0px 0px 15px; + } + .navbar-expand-lg ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + margin: 0; + } + .navbar-expand-lg ul.navbar-nav > li.dropdown-mega .dropdown-mega-content > .row > div { + padding: 0px 15px; + } + .navbar-expand-lg.navbar-text-light .navbar-collapse { + background: rgba(0, 0, 0, 0.95); + } + .navbar-expand-lg.navbar-text-light .navbar-collapse ul.navbar-nav li { + border-color: rgba(250, 250, 250, 0.15); + } + .navbar-expand-lg.navbar-dropdown-dark .navbar-collapse { + background-color: #252A2C; + } + .navbar-expand-lg.navbar-dropdown-primary .navbar-collapse { + background-color: #0366d6; + } + .navbar-expand-lg.navbar-dropdown-primary ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + background-color: #0366d6; + } + .navbar-expand-lg.navbar-dropdown-dark ul.navbar-nav li { + border-color: #444; + } + .navbar-expand-lg.navbar-dropdown-dark ul.navbar-nav > li > a { + color: #a3a2a2; + } + .navbar-expand-lg.navbar-dropdown-dark ul.navbar-nav > li:hover > a { + color: #fff; + } + .navbar-expand-lg.navbar-dropdown-primary ul.navbar-nav li { + border-color: rgba(250, 250, 250, 0.2); + } + .navbar-expand-lg.navbar-dropdown-primary ul.navbar-nav > li > a { + color: rgba(250, 250, 250, 0.8); + } + .navbar-expand-lg.navbar-dropdown-primary ul.navbar-nav > li:hover > a { + color: #fff; + } +} +@media (max-width: 1199.98px) { + .navbar-expand-xl .navbar-collapse { + position: absolute; + top: 99%; + right: 0; + left: 0; + background: #fff; + margin-top: 0px; + z-index: 1000; + -webkit-box-shadow: 0px 0px 15px rgba(0, 0, 0, 0.1); + box-shadow: 0px 0px 15px rgba(0, 0, 0, 0.1); + } + .navbar-expand-xl .navbar-collapse .navbar-nav { + overflow: hidden; + overflow-y: auto; + max-height: 65vh; + padding: 15px; + } + .navbar-expand-xl ul.navbar-nav li { + display: block; + border-bottom: 1px solid #eee; + margin: 0; + padding: 0; + } + .navbar-expand-xl ul.navbar-nav li:last-child { + border: none; + } + .navbar-expand-xl ul.navbar-nav li + li { + margin-left: 0px; + } + .navbar-expand-xl ul.navbar-nav li.dropdown > .dropdown-toggle > .arrow.show:after { + -webkit-transform: translate(-50%, -50%) rotate(-45deg); + transform: translate(-50%, -50%) rotate(-45deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + } + .navbar-expand-xl ul.navbar-nav li > a:hover:after, .navbar-expand-xl ul.navbar-nav li > a.active:after { + content: none !important; + width: 0px !important; + } + .navbar-expand-xl ul.navbar-nav li.dropdown > .dropdown-toggle .arrow { + display: block; + } + .navbar-expand-xl ul.navbar-nav > li > a:not(.btn) { + height: auto; + padding: 8px 0; + position: relative; + } + .navbar-expand-xl ul.navbar-nav > li.dropdown .dropdown-menu li > a:not(.btn) { + padding: 8px 0; + position: relative; + } + .navbar-expand-xl ul.navbar-nav > li.dropdown:hover > a:after { + content: none; + } + .navbar-expand-xl ul.navbar-nav > li.dropdown .dropdown-toggle .arrow:after { + -webkit-transform: translate(-50%, -50%) rotate(134deg); + transform: translate(-50%, -50%) rotate(134deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + } + .navbar-expand-xl ul.navbar-nav > li.dropdown .dropdown-menu { + margin: 0; + -webkit-box-shadow: none; + box-shadow: none; + border: none; + padding: 0px 0px 0px 15px; + } + .navbar-expand-xl ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + margin: 0; + } + .navbar-expand-xl ul.navbar-nav > li.dropdown-mega .dropdown-mega-content > .row > div { + padding: 0px 15px; + } + .navbar-expand-xl.navbar-text-light .navbar-collapse { + background: rgba(0, 0, 0, 0.95); + } + .navbar-expand-xl.navbar-text-light .navbar-collapse ul.navbar-nav li { + border-color: rgba(250, 250, 250, 0.15); + } + .navbar-expand-xl.navbar-dropdown-dark .navbar-collapse { + background-color: #252A2C; + } + .navbar-expand-xl.navbar-dropdown-primary .navbar-collapse { + background-color: #0366d6; + } + .navbar-expand-xl.navbar-dropdown-primary ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + background-color: #0366d6; + } + .navbar-expand-xl.navbar-dropdown-dark ul.navbar-nav li { + border-color: #444; + } + .navbar-expand-xl.navbar-dropdown-dark ul.navbar-nav > li > a { + color: #a3a2a2; + } + .navbar-expand-xl.navbar-dropdown-dark ul.navbar-nav > li:hover > a { + color: #fff; + } + .navbar-expand-xl.navbar-dropdown-primary ul.navbar-nav li { + border-color: rgba(250, 250, 250, 0.2); + } + .navbar-expand-xl.navbar-dropdown-primary ul.navbar-nav > li > a { + color: rgba(250, 250, 250, 0.8); + } + .navbar-expand-xl.navbar-dropdown-primary ul.navbar-nav > li:hover > a { + color: #fff; + } +} +/* =================================== */ +/* 5. Elements +/* =================================== */ +/*=== 5.1 List Style ===*/ +.list-style-1 > li { + position: relative; + list-style-type: none; + line-height: 24px; +} +.list-style-1 > li:after { + content: " "; + position: absolute; + top: 12px; + left: -15px; + border-color: #000; + border-top: 1px solid; + border-right: 1px solid; + width: 6px; + height: 6px; + -webkit-transform: translate(-50%, -50%) rotate(45deg); + transform: translate(-50%, -50%) rotate(45deg); +} + +.list-style-2 { + padding: 0; +} + +.list-style-2 > li { + list-style-type: none; + border-bottom: 1px solid #eaeaea; + padding-top: 12px; + padding-bottom: 12px; +} + +.list-style-2.list-style-light > li { + border-bottom: 1px solid rgba(250, 250, 250, 0.12); +} + +/*=== 5.2 Changelog ===*/ +.changelog { + list-style: none; + padding: 0; +} +.changelog .badge { + width: 90px; + margin-right: 10px; + border-radius: .20rem; + text-transform: uppercase; +} +.changelog li { + line-height: 1.8; +} + +/*=== 5.3 Accordion & Toggle ===*/ +.accordion .card { + border: none; + margin-bottom: 16px; + margin-bottom: 1rem; + background-color: transparent; +} +.accordion .card-header { + padding: 0; + border: none; + background: none; +} +.accordion .card-header a { + font-size: 16px; + font-weight: normal; + padding: 1rem 1.25rem 1rem 2.25rem; + display: block; + border-radius: 4px; + position: relative; +} +.accordion .card-header a:hover { + text-decoration: none; +} +.accordion .card-header a:hover.collapsed { + color: #0366d6 !important; +} +.accordion:not(.accordion-alternate) .card-header a { + background-color: #76ace8; + color: #fff; +} +.accordion:not(.accordion-alternate) .card-header a.collapsed { + background-color: #f1f2f4; + color: #4c4d4d; +} +.accordion .card-header a:before { + position: absolute; + content: " "; + left: 20px; + top: calc(50% + 2px); + width: 9px; + height: 9px; + border-color: #CCC; + border-top: 2px solid; + border-right: 2px solid; + -webkit-transform: translate(-50%, -50%) rotate(-45deg); + transform: translate(-50%, -50%) rotate(-45deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + -webkit-backface-visibility: hidden; + backface-visibility: hidden; +} +.accordion .card-header a.collapsed:before { + top: calc(50% - 2px); + -webkit-transform: translate(-50%, -50%) rotate(135deg); + transform: translate(-50%, -50%) rotate(135deg); +} +.accordion .card-body { + line-height: 26px; + border: 1px solid #ccc; + margin-top: -4px; + border-radius: 4px; +} +.accordion.arrow-right .card-header a { + padding-left: 1.25rem; +} +.accordion.arrow-right .card-header a:before { + right: 15px; + left: auto; +} +.accordion.accordion-alternate .card { + margin: 0; +} +.accordion.accordion-alternate .card-header a { + padding-left: 1.40rem; + border-top: 1px solid #e4e9ec; + border-radius: 0px; +} +.accordion.accordion-alternate .card:first-of-type .card-header a { + border-top: 0px; +} +.accordion.accordion-alternate .card-header a:before { + left: 6px; +} +.accordion.accordion-alternate .card-header a.collapsed { + color: #4c4d4d; +} +.accordion.accordion-alternate .card-body { + padding: 0rem 0 1rem 1.25rem; +} +.accordion.accordion-alternate.arrow-right .card-header a { + padding-left: 0; +} +.accordion.accordion-alternate.arrow-right .card-header a:before { + right: 0px; + left: auto; +} +.accordion.toggle .card-header a:before { + content: "-"; + border: none; + font-size: 20px; + height: auto; + top: calc(50% + 2px); + width: auto; + -webkit-transform: translate(-50%, -50%) rotate(180deg); + transform: translate(-50%, -50%) rotate(180deg); +} +.accordion.toggle .card-header a.collapsed:before { + content: "+"; + top: calc(50% - 1px); + -webkit-transform: translate(-50%, -50%) rotate(0deg); + transform: translate(-50%, -50%) rotate(0deg); +} +.accordion.accordion-alternate.style-2 .card-header a { + padding-left: 0px; +} +.accordion.accordion-alternate.style-2 .card-header a:before { + right: 2px; + left: auto; + -webkit-transform: translate(-50%, -50%) rotate(135deg); + transform: translate(-50%, -50%) rotate(135deg); + top: 50%; +} +.accordion.accordion-alternate.style-2 .card-header a.collapsed:before { + -webkit-transform: translate(-50%, -50%) rotate(45deg); + transform: translate(-50%, -50%) rotate(45deg); +} +.accordion.accordion-alternate.style-2 .card-body { + padding-left: 0px; +} +.accordion.accordion-alternate.popularRoutes .card-header .nav { + margin-top: 3px; +} +.accordion.accordion-alternate.popularRoutes .card-header .nav a { + font-size: 14px; +} +.accordion.accordion-alternate.popularRoutes .card-header a { + padding: 0px 8px 0px 0px; + border: none; + font-size: inherit; +} +.accordion.accordion-alternate.popularRoutes .card-header a:before { + content: none; +} +.accordion.accordion-alternate.popularRoutes .card-header h5 { + cursor: pointer; +} +.accordion.accordion-alternate.popularRoutes .card-header h5:before { + position: absolute; + content: " "; + right: 0px; + top: 24px; + width: 10px; + height: 10px; + opacity: 0.6; + border-top: 2px solid; + border-right: 2px solid; + -webkit-transform: translate(-50%, -50%) rotate(-45deg); + transform: translate(-50%, -50%) rotate(-45deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + -webkit-backface-visibility: hidden; + backface-visibility: hidden; +} +.accordion.accordion-alternate.popularRoutes .card-header h5.collapsed:before { + top: 24px; + -webkit-transform: translate(-50%, -50%) rotate(135deg); + transform: translate(-50%, -50%) rotate(135deg); +} +.accordion.accordion-alternate.popularRoutes .card-body { + padding: 0; +} +.accordion.accordion-alternate.popularRoutes .card { + border-bottom: 2px solid #e4e9ec; + padding: 15px 0px; +} +.accordion.accordion-alternate.popularRoutes .routes-list { + margin: 1rem 0px 0px 0px; + padding: 0px; + list-style: none; +} +.accordion.accordion-alternate.popularRoutes .routes-list a { + color: inherit; + display: -ms-flexbox !important; + display: flex !important; + -ms-flex-align: center !important; + align-items: center !important; +} +.accordion.accordion-alternate.popularRoutes .routes-list a:hover { + color: #0071cc; + text-decoration: underline; +} + +/* 5.4 Nav */ +.nav .nav-item .nav-link { + color: #222222; +} + +.nav.nav-light .nav-item .nav-link { + color: #ddd; +} + +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover { + color: #0366d6; +} + +.nav-pills .nav-link:not(.active):hover { + color: #0366d6; +} + +.nav-pills .nav-link.active, .nav-pills.nav-light .nav-link.active, .nav-pills .show > .nav-link { + color: #fff; +} + +.nav.nav-separator .nav-item .nav-link { + position: relative; +} + +.nav.nav-separator .nav-item + .nav-item .nav-link:after { + height: 14px; + width: 1px; + content: ' '; + background-color: rgba(0, 0, 0, 0.2); + display: block; + position: absolute; + top: 50%; + left: 0; + -webkit-transform: translateY(-7px); + transform: translateY(-7px); +} + +.nav.nav-separator.nav-separator-light .nav-item + .nav-item .nav-link:after { + background-color: rgba(250, 250, 250, 0.2); +} + +.nav.nav-sm .nav-item .nav-link { + font-size: 14px; +} + +/*=== 5.5 Tabs ===*/ +.nav-tabs { + border-bottom: 1px solid #d7dee3; + padding-bottom: 16px; +} +.nav-tabs .nav-item .nav-link { + border: 0; + background: transparent; + position: relative; + border-radius: 0; + padding: 0.6rem 1rem; + color: #7b8084; + white-space: nowrap !important; +} +.nav-tabs .nav-item .nav-link.active { + color: #0c2f55; +} +.nav-tabs .nav-item .nav-link.active:after { + height: 2px; + width: 100%; + content: ' '; + background-color: #0366d6; + display: block; + position: absolute; + bottom: -3px; + left: 0; + -webkit-transform: translateY(-3px); + transform: translateY(-3px); +} +.nav-tabs .nav-item .nav-link:not(.active):after { + height: 2px; + width: calc(100% - 10px); + content: ' '; + background-color: #aaa; + display: block; + margin: 0 5px; + position: absolute; + bottom: -3px; + left: 0; + -webkit-transform: translateY(-3px); + transform: translateY(-3px); +} +.nav-tabs .nav-item .nav-link:not(.active):hover { + color: #0366d6; +} +.nav-tabs.flex-column { + border-right: 1px solid #d7dee3; + border-bottom: 0px; + padding: 1.5rem 0; +} +.nav-tabs.flex-column .nav-item .nav-link { + border: 1px solid #d7dee3; + border-right: 0px; + background-color: #f6f7f8; + font-size: 14px; + padding: 0.75rem 1rem; + color: #535b61; +} +.nav-tabs.flex-column .nav-item:first-of-type .nav-link { + border-top-left-radius: 4px; +} +.nav-tabs.flex-column .nav-item:last-of-type .nav-link { + border-bottom-left-radius: 4px; +} +.nav-tabs.flex-column .nav-item .nav-link.active { + background-color: transparent; + color: #0366d6; +} +.nav-tabs.flex-column .nav-item .nav-link.active:after { + height: 100%; + width: 2px; + background: #fff; + right: -1px; + left: auto; +} + +.nav-tabs:not(.flex-column) { + overflow: hidden; + overflow-x: auto; + -ms-overflow-style: -ms-autohiding-scrollbar; + -webkit-overflow-scrolling: touch; +} +.nav-tabs:not(.flex-column) .nav-item { + margin-bottom: 0px; +} + +@media (max-width: 575.98px) { + .nav-tabs .nav-item .nav-link { + padding-left: 0px; + padding-right: 0px; + margin-right: 10px; + font-size: 0.875rem; + } +} +/*=== 5.6 Popup Img ===*/ +.popup-img img { + -webkit-transition: all 0.2s ease-in-out; + transition: all 0.2s ease-in-out; +} + +.popup-img:hover img { + opacity: 0.8; + cursor: -webkit-zoom-in; + cursor: -moz-zoom-in; + cursor: zoom-in; +} + +/*=== 5.7 Featured Box ===*/ +.featured-box { + box-sizing: border-box; + position: relative; +} +.featured-box h3, .featured-box h4 { + font-size: 1.25rem; + font-size: 20px; + margin-bottom: 10px; + font-weight: 500; +} +.featured-box:not(.style-5) .featured-box-icon { + display: inline-block; + font-size: 48px; + min-width: 55px; + min-height: 55px; + padding: 0; + margin-top: 0; + margin-bottom: 0.8rem; + color: #4c4d4d; + border-radius: 0; +} +.featured-box.style-1, .featured-box.style-2, .featured-box.style-3 { + padding-left: 50px; + padding-top: 8px; +} +.featured-box.style-1 .featured-box-icon, .featured-box.style-2 .featured-box-icon, .featured-box.style-3 .featured-box-icon { + position: absolute; + top: 0; + left: 0; + margin-bottom: 0; + font-size: 30px; + -ms-flex-pack: center !important; + justify-content: center !important; + text-align: center; +} +.featured-box.style-2 p { + margin-left: -50px; +} +.featured-box.style-3 { + padding-left: 90px; + padding-top: 0px; +} +.featured-box.style-3 .featured-box-icon { + width: 70px; + height: 70px; + -ms-flex-negative: 0; + flex-shrink: 0; + display: -webkit-box; + display: -ms-flexbox; + display: flex; + -webkit-box-align: center; + -ms-flex-align: center; + align-items: center; +} +.featured-box.style-4 { + text-align: center; +} +.featured-box.style-4 .featured-box-icon { + margin: 0 auto 24px; + margin: 0 auto 1.5rem; + width: 120px; + height: 120px; + text-align: center; + -ms-flex-negative: 0; + flex-shrink: 0; + display: -webkit-box; + display: -ms-flexbox; + display: flex; + -webkit-box-align: center; + -ms-flex-align: center; + align-items: center; + -ms-flex-pack: center; + justify-content: center; + -webkit-box-shadow: 0px 0px 50px rgba(0, 0, 0, 0.03); + box-shadow: 0px 0px 50px rgba(0, 0, 0, 0.03); +} +.featured-box.style-5 { + text-align: center; + background: #fff; + border: 1px solid #f0f2f3; + -webkit-box-shadow: 0px 2px 5px rgba(0, 0, 0, 0.05); + box-shadow: 0px 2px 5px rgba(0, 0, 0, 0.05); + -webkit-transition: all 0.3s ease-in-out; + transition: all 0.3s ease-in-out; +} +.featured-box.style-5:hover { + border: 1px solid #ebeded; + -webkit-box-shadow: 0px 5px 1.5rem rgba(0, 0, 0, 0.15); + box-shadow: 0px 5px 1.5rem rgba(0, 0, 0, 0.15); +} +.featured-box.style-5 h3 { + background: #f1f5f6; + font-size: 16px; + padding: 8px 0; + margin-bottom: 0px; +} +.featured-box.style-5 .featured-box-icon { + font-size: 50px; + margin: 44px 0px; +} + +.featured-box.featured-box-reverse { + text-align: right; +} +.featured-box.featured-box-reverse.style-1, .featured-box.featured-box-reverse.style-2 { + padding-right: 50px; + padding-left: 0px; +} +.featured-box.featured-box-reverse.style-1 .featured-box-icon, .featured-box.featured-box-reverse.style-2 .featured-box-icon { + left: auto; + right: 0px; +} +.featured-box.featured-box-reverse.style-2 p { + margin-right: -50px; + margin-left: 0; +} +.featured-box.featured-box-reverse.style-3 { + padding-left: 0; + padding-right: 90px; +} +.featured-box.featured-box-reverse.style-3 .featured-box-icon { + left: auto; + right: 0px; +} + +.featured-box.featured-box-reverse-sm { + text-align: right; +} +.featured-box.featured-box-reverse-sm.style-1, .featured-box.featured-box-reverse-sm.style-2 { + padding-right: 50px; + padding-left: 0px; +} +.featured-box.featured-box-reverse-sm.style-1 .featured-box-icon, .featured-box.featured-box-reverse-sm.style-2 .featured-box-icon { + left: auto; + right: 0px; +} +.featured-box.featured-box-reverse-sm.style-2 p { + margin-right: -50px; + margin-left: 0; +} +.featured-box.featured-box-reverse-sm.style-3 { + padding-left: 0; + padding-right: 90px; +} +.featured-box.featured-box-reverse-sm.style-3 .featured-box-icon { + left: auto; + right: 0px; +} + +@media (min-width: 576px) { + .featured-box.featured-box-reverse-md { + text-align: right; + } + .featured-box.featured-box-reverse-md.style-1, .featured-box.featured-box-reverse-md.style-2 { + padding-right: 50px; + padding-left: 0px; + } + .featured-box.featured-box-reverse-md.style-1 .featured-box-icon, .featured-box.featured-box-reverse-md.style-2 .featured-box-icon { + left: auto; + right: 0px; + } + .featured-box.featured-box-reverse-md.style-2 p { + margin-right: -50px; + margin-left: 0; + } + .featured-box.featured-box-reverse-md.style-3 { + padding-left: 0; + padding-right: 90px; + } + .featured-box.featured-box-reverse-md.style-3 .featured-box-icon { + left: auto; + right: 0px; + } +} +@media (min-width: 768px) { + .featured-box.featured-box-reverse-lg { + text-align: right; + } + .featured-box.featured-box-reverse-lg.style-1, .featured-box.featured-box-reverse-lg.style-2 { + padding-right: 50px; + padding-left: 0px; + } + .featured-box.featured-box-reverse-lg.style-1 .featured-box-icon, .featured-box.featured-box-reverse-lg.style-2 .featured-box-icon { + left: auto; + right: 0px; + } + .featured-box.featured-box-reverse-lg.style-2 p { + margin-right: -50px; + margin-left: 0; + } + .featured-box.featured-box-reverse-lg.style-3 { + padding-left: 0; + padding-right: 90px; + } + .featured-box.featured-box-reverse-lg.style-3 .featured-box-icon { + left: auto; + right: 0px; + } +} +@media (min-width: 992px) { + .featured-box.featured-box-reverse-xl { + text-align: right; + } + .featured-box.featured-box-reverse-xl.style-1, .featured-box.featured-box-reverse-xl.style-2 { + padding-right: 50px; + padding-left: 0px; + } + .featured-box.featured-box-reverse-xl.style-1 .featured-box-icon, .featured-box.featured-box-reverse-xl.style-2 .featured-box-icon { + left: auto; + right: 0px; + } + .featured-box.featured-box-reverse-xl.style-2 p { + margin-right: -50px; + margin-left: 0; + } + .featured-box.featured-box-reverse-xl.style-3 { + padding-left: 0; + padding-right: 90px; + } + .featured-box.featured-box-reverse-xl.style-3 .featured-box-icon { + left: auto; + right: 0px; + } +} +/* =================================== */ +/* 6. Footer +/* =================================== */ +#footer { + background: #fff; + color: #252b33; + margin-left: 260px; + padding: 66px 0px; + padding: 4.125rem 0; +} +#footer .nav .nav-item { + display: inline-block; + line-height: 12px; + margin: 0; +} +#footer .nav .nav-item .nav-link { + color: #252b33; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +#footer .nav .nav-item .nav-link:focus { + color: #0366d6; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +#footer .nav .nav-item:first-child .nav-link { + padding-left: 0px; +} +#footer .nav .nav-item:last-child .nav-link { + padding-right: 0px; +} +#footer .nav .nav-link:hover { + color: #0366d6; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +#footer .footer-copyright { + border-top: 1px solid #e2e8ea; + padding: 0px 0px; + color: #67727c; +} +#footer .footer-copyright .nav .nav-item .nav-link { + color: #67727c; +} +#footer .footer-copyright .nav .nav-link:hover { + color: #0366d6; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +#footer .nav.flex-column .nav-item { + padding: 0px; +} +#footer .nav.flex-column .nav-item .nav-link { + margin: 0.7rem 0px; +} +#footer.footer-text-light { + color: rgba(250, 250, 250, 0.8); +} +#footer.footer-text-light .nav .nav-item .nav-link { + color: rgba(250, 250, 250, 0.8); +} +#footer.footer-text-light .nav .nav-item .nav-link:hover { + color: #fafafa; +} +#footer.footer-text-light .footer-copyright { + border-color: rgba(250, 250, 250, 0.15); + color: rgba(250, 250, 250, 0.5); +} +#footer.footer-text-light:not(.bg-primary) .social-icons-light.social-icons li a { + color: rgba(250, 250, 250, 0.8); +} +#footer.footer-text-light:not(.bg-primary) .social-icons-light.social-icons li a:hover { + color: #fafafa; +} +#footer.footer-text-light.bg-primary { + color: #fff; +} +#footer.footer-text-light.bg-primary .nav .nav-item .nav-link { + color: #fff; +} +#footer.footer-text-light.bg-primary .nav .nav-item .nav-link:hover { + color: rgba(250, 250, 250, 0.7); +} +#footer.footer-text-light.bg-primary .footer-copyright { + border-color: rgba(250, 250, 250, 0.15); + color: rgba(250, 250, 250, 0.9); +} +#footer.footer-text-light.bg-primary :not(.social-icons) a { + color: #fff; +} +#footer.footer-text-light.bg-primary :not(.social-icons) a:hover { + color: rgba(250, 250, 250, 0.7); +} + +@media (max-width: 767.98px) { + #footer { + margin-left: 0px; + } +} +/*=== 6.1 Social Icons ===*/ +.social-icons { + margin: 0; + padding: 0; + display: -ms-flexbox; + display: flex; + -ms-flex-wrap: wrap; + flex-wrap: wrap; + list-style: none; +} +.social-icons li { + margin: 0px 6px; + padding: 0; + overflow: visible; +} +.social-icons-ce { + margin-right: 120px !important; +} +.social-icons-nuget{ + margin-right: 24px !important; +} +.social-icons li a { + display: block; + height: 26px; + line-height: 26px; + width: 26px; + font-size: 18px; + text-align: center; + color: #4d555a; + text-decoration: none; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +.social-icons li i { + line-height: inherit; +} +.social-icons.social-icons-sm li { + margin: 0px 4px; +} +.social-icons.social-icons-sm li a { + font-size: 15px; + width: 22px; +} +.social-icons.social-icons-lg li a { + width: 34px; + height: 34px; + line-height: 34px; + font-size: 22px; +} +.social-icons.social-icons-light li a { + color: #eee; +} +.social-icons.social-icons-muted li a { + color: #aab1b8; +} +.social-icons li:hover a { + color: #999; +} + +/*=== 6.2 Back to Top ===*/ +#back-to-top { + display: none; + position: fixed; + z-index: 1030; + bottom: 8px; + right: 10px; + background-color: rgba(0, 0, 0, 0.22); + text-align: center; + color: #fff; + font-size: 14px; + width: 36px; + height: 36px; + line-height: 34px; + border-radius: 3px; + -webkit-transition: all 0.3s ease-in-out; + transition: all 0.3s ease-in-out; + -webkit-box-shadow: 0px 5px 15px rgba(0, 0, 0, 0.15); + box-shadow: 0px 5px 15px rgba(0, 0, 0, 0.15); +} +#back-to-top:hover { + background-color: #0366d6; + -webkit-box-shadow: 0px 5px 15px rgba(0, 0, 0, 0.25); + box-shadow: 0px 5px 15px rgba(0, 0, 0, 0.25); + -webkit-transition: all 0.3s ease-in-out; + transition: all 0.3s ease-in-out; +} + +@media (max-width: 575.98px) { + #back-to-top { + z-index: 1029; + } +} +/* =================================== */ +/* Extras +/* =================================== */ +/* Bootstrap Specific */ +.form-control, .custom-select { + border-color: #dae1e3; + font-size: 16px; + color: #656565; +} + +.form-control:not(.form-control-sm) { + padding: .810rem .96rem; + height: inherit; +} + +.form-control-sm { + font-size: 14px; +} + +.icon-inside { + position: absolute; + right: 15px; + top: calc(50% - 11px); + pointer-events: none; + font-size: 18px; + font-size: 1.125rem; + color: #c4c3c3; + z-index: 3; +} + +.form-control-sm + .icon-inside { + font-size: 0.875rem !important; + font-size: 14px; + top: calc(50% - 13px); +} + +select.form-control:not([size]):not([multiple]):not(.form-control-sm) { + height: auto; + padding-top: .700rem; + padding-bottom: .700rem; +} + +.custom-select:not(.custom-select-sm) { + height: calc(3.05rem + 2px); + padding-top: .700rem; + padding-bottom: .700rem; +} + +.col-form-label-sm { + font-size: 13px; +} + +.custom-select-sm { + padding-left: 5px !important; + font-size: 14px; +} + +.custom-select:not(.custom-select-sm).border-0 { + height: 3.00rem; +} + +.form-control:focus, .custom-select:focus { + -webkit-box-shadow: 0 0 5px rgba(128, 189, 255, 0.5); + box-shadow: 0 0 5px rgba(128, 189, 255, 0.5); +} + +.form-control:focus[readonly] { + box-shadow: none; +} + +.input-group-text { + border-color: #dae1e3; + background-color: #f1f5f6; + color: #656565; +} + +.form-control::-webkit-input-placeholder { + color: #b1b4b6; +} +.form-control:-moz-placeholder { + /* FF 4-18 */ + color: #b1b4b6; +} +.form-control::-moz-placeholder { + /* FF 19+ */ + color: #b1b4b6; +} +.form-control:-ms-input-placeholder, .form-control::-ms-input-placeholder { + /* IE 10+ */ + color: #b1b4b6; +} + +/* Form Dark */ +.form-dark .form-control, .form-dark .custom-select { + border-color: #232a31; + background: #232a31; + color: #fff; +} +.form-dark .form-control:focus { + border-color: #80bdff !important; +} +.form-dark .form-control::-webkit-input-placeholder { + color: #777b7f; +} +.form-dark .form-control:-moz-placeholder { + /* FF 4-18 */ + color: #777b7f; +} +.form-dark .form-control::-moz-placeholder { + /* FF 19+ */ + color: #777b7f; +} +.form-dark .form-control:-ms-input-placeholder, .form-dark .form-control::-ms-input-placeholder { + /* IE 10+ */ + color: #777b7f; +} +.form-dark .custom-select { + color: #777b7f; + background: url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 4 5'%3E%3Cpath fill='rgba(250,250,250,0.3)' d='M2 0L0 2h4zm0 5L0 3h4z'/%3E%3C/svg%3E") no-repeat right 0.75rem center; + background-size: 13px 15px; + border-color: #232a31; + background-color: #232a31; +} +.form-dark .icon-inside { + color: #777b7f; +} + +/* Input with only bottom border */ +.form-border .form-control { + background-color: transparent; + border: none; + border-bottom: 2px solid rgba(0, 0, 0, 0.12); + border-radius: 0px; + padding-left: 0px !important; + color: black; +} +.form-border .form-control::-webkit-input-placeholder { + color: rgba(0, 0, 0, 0.4); +} +.form-border .form-control:-moz-placeholder { + /* FF 4-18 */ + color: rgba(0, 0, 0, 0.4); +} +.form-border .form-control::-moz-placeholder { + /* FF 19+ */ + color: rgba(0, 0, 0, 0.4); +} +.form-border .form-control:-ms-input-placeholder, .form-border .form-control::-ms-input-placeholder { + /* IE 10+ */ + color: rgba(0, 0, 0, 0.4); +} +.form-border .custom-select { + background-color: transparent; + border: none; + border-bottom: 2px solid rgba(0, 0, 0, 0.12); + border-radius: 0px; + padding-left: 0px; + color: rgba(0, 0, 0, 0.4); + background: url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 4 5'%3E%3Cpath fill='rgba(0,0,0,0.3)' d='M2 0L0 2h4zm0 5L0 3h4z'/%3E%3C/svg%3E") no-repeat right 0.75rem center; + background-size: 13px 15px; +} +.form-border .form-control:focus, .form-border .custom-select:focus { + box-shadow: none; + -webkit-box-shadow: none; + border-bottom: 2px solid rgba(0, 0, 0, 0.7); +} +.form-border .form-control:not(output):-moz-ui-invalid:not(:focus), .form-border .form-control:not(output):-moz-ui-invalid:-moz-focusring:not(:focus), .form-border .custom-select:not(output):-moz-ui-invalid:not(:focus), .form-border .custom-select:not(output):-moz-ui-invalid:-moz-focusring:not(:focus) { + border-bottom: 2px solid #b00708; + box-shadow: none; + -webkit-box-shadow: none; +} +.form-border .icon-inside { + color: rgba(0, 0, 0, 0.25); +} +.form-border select option { + color: #666; +} + +.form-border-light .form-control { + border-bottom: 2px solid rgba(250, 250, 250, 0.3); + color: #fafafa; +} +.form-border-light .form-control::-webkit-input-placeholder { + color: rgba(250, 250, 250, 0.7); +} +.form-border-light .form-control:-moz-placeholder { + /* FF 4-18 */ + color: rgba(250, 250, 250, 0.7); +} +.form-border-light .form-control::-moz-placeholder { + /* FF 19+ */ + color: rgba(250, 250, 250, 0.7); +} +.form-border-light .form-control:-ms-input-placeholder, .form-border-light .form-control::-ms-input-placeholder { + /* IE 10+ */ + color: rgba(250, 250, 250, 0.7); +} +.form-border-light .custom-select { + border-bottom: 2px solid rgba(250, 250, 250, 0.3); + color: #fafafa; + background: url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 4 5'%3E%3Cpath fill='rgba(250,250,250,0.6)' d='M2 0L0 2h4zm0 5L0 3h4z'/%3E%3C/svg%3E") no-repeat right 0.75rem center; + background-size: 13px 15px; +} +.form-border-light .form-control:focus, .form-border-light .custom-select:focus { + border-bottom: 2px solid rgba(250, 250, 250, 0.8); +} +.form-border-light .icon-inside { + color: #999; +} +.form-border-light select option { + color: #333; +} + +.input-group-append .btn, .input-group-prepend .btn { + -webkit-box-shadow: none; + box-shadow: none; + padding-left: 0.75rem; + padding-right: 0.75rem; +} + +.input-group-append .btn:hover, .input-group-prepend .btn:hover { + -webkit-box-shadow: none; + box-shadow: none; +} + +@media (max-width: 575.98px) { + .input-group > .input-group-append > .btn, .input-group > .input-group-prepend > .btn { + padding: 0 0.75rem; + } +} +.bg-primary, .badge-primary { + background-color: #0366d6 !important; +} + +.bg-secondary { + background-color: #6c757d !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: #0366d6 !important; +} + +.btn-link:hover { + color: #0355b3 !important; +} + +.text-secondary { + color: #6c757d !important; +} + +.text-light { + color: #dee3e4 !important; +} + +.text-body { + color: #4c4d4d !important; +} + +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover { + background-color: #0355b3 !important; +} + +.border-primary { + border-color: #0366d6 !important; +} + +.border-secondary { + border-color: #6c757d !important; +} + +.btn-primary { + background-color: #0366d6; + border-color: #0366d6; +} +.btn-primary:hover { + background-color: #0355b3; + border-color: #0355b3; +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active { + background-color: #0355b3; + border-color: #0355b3; +} + +.btn-primary.focus, .btn-primary:focus { + background-color: #0355b3; + border-color: #0355b3; +} + +.btn-primary:not(:disabled):not(.disabled).active:focus, .btn-primary:not(:disabled):not(.disabled):active:focus, .show > .btn-primary.dropdown-toggle:focus { + -webkit-box-shadow: none; + box-shadow: none; +} + +.btn-secondary { + background-color: #6c757d; + border-color: #6c757d; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active { + color: #0366d6; + border-color: #0366d6; +} +.btn-outline-primary:hover, .btn-outline-primary:not(:disabled):not(.disabled).active:hover, .btn-outline-primary:not(:disabled):not(.disabled):active:hover { + background-color: #0366d6; + border-color: #0366d6; + color: #fff; +} + +.btn-outline-secondary { + color: #6c757d; + border-color: #6c757d; +} +.btn-outline-secondary:hover { + background-color: #6c757d; + border-color: #6c757d; + color: #fff; +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active { + background-color: #0366d6; +} + +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before { + background-color: #0366d6; + border-color: #0366d6; +} + +.list-group-item.active { + background-color: #0366d6; + border-color: #0366d6; +} + +.page-link { + color: #0366d6; +} +.page-link:hover { + color: #0355b3; +} + +/* Pagination */ +.page-link { + border: none; + border-radius: 0.25rem; + margin: 0 0.22rem; + font-size: 16px; + font-size: 1rem; +} +.page-link:hover { + background-color: #e9eff0; +} + +/* Vertical Multilple input group */ +.vertical-input-group .input-group:first-child { + padding-bottom: 0; +} +.vertical-input-group .input-group:first-child * { + border-bottom-left-radius: 0; + border-bottom-right-radius: 0; +} +.vertical-input-group .input-group:last-child { + padding-top: 0; +} +.vertical-input-group .input-group:last-child * { + border-top-left-radius: 0; + border-top-right-radius: 0; +} +.vertical-input-group .input-group:not(:last-child):not(:first-child) { + padding-top: 0; + padding-bottom: 0; +} +.vertical-input-group .input-group:not(:last-child):not(:first-child) * { + border-radius: 0; +} +.vertical-input-group .input-group:not(:first-child) * { + border-top: 0; +} + +/* styles-switcher */ +#styles-switcher { + background: #fff; + width: 202px; + position: fixed; + top: 35%; + z-index: 99; + padding: 20px; + left: -202px; +} +#styles-switcher ul { + padding: 0; +} +#styles-switcher ul li { + list-style-type: none; + width: 25px; + height: 25px; + margin: 4px 2px; + border-radius: 50%; + display: inline-block; + cursor: pointer; + transition: all .2s ease-in-out; +} +#styles-switcher ul li.blue { + background: #007bff; +} +#styles-switcher ul li.brown { + background: #795548; +} +#styles-switcher ul li.purple { + background: #6f42c1; +} +#styles-switcher ul li.indigo { + background: #6610f2; +} +#styles-switcher ul li.red { + background: #dc3545; +} +#styles-switcher ul li.orange { + background: #fd7e14; +} +#styles-switcher ul li.yellow { + background: #ffc107; +} +#styles-switcher ul li.green { + background: #28a745; +} +#styles-switcher ul li.teal { + background: #20c997; +} +#styles-switcher ul li.cyan { + background: #17a2b8; +} +#styles-switcher ul li.active { + transform: scale(0.7); + cursor: default; +} +#styles-switcher .switcher-toggle { + position: absolute; + background: #333; + color: #fff; + font-size: 1.25rem; + border-radius: 0px 4px 4px 0; + right: -40px; + top: 0; + width: 40px; + height: 40px; + padding: 0; +} +#styles-switcher #reset-color { + background: #e83e8c; +} + +input:-internal-autofill-selected { + background-color: transparent; +} + +#styles-switcher.right { + left: auto; + right: -202px; +} + +#styles-switcher.right .switcher-toggle { + right: auto; + left: -40px; + border-radius: 4px 0px 0px 4px; +} + +.tab-wrap{ + border-top: 1px solid #eee; + border-bottom: 1px solid #eee; + padding: 0 10px; + margin-bottom: 40px; +} diff --git a/docs/assets/images/logo.png b/docs/assets/images/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..225c6449f319e8617e1687df03335c47fc855909 GIT binary patch literal 4691 zcmV-Z60GfsP)Px#1ZP1_K>z@;j|==^1poj532;bRa{vGizW@LZzX3P}QzQTY5$H)oK~#8NK3b&v@@%{ubG|QIo|7h|Nq|1&W?6=o(@-K%b)0d z-Tk`z_5bz%|NZxSgVI{l?=w;a+!0o;?r5>A%x~y(BX0NNX@lnJz9LtHCu|-VF7ebB zCXD8g-&0%OmpIok#k-(16h9O!%&V9hiM5=|^K~p63dul|3_`$^GglQFT75?;U9L?v zqTG6>snvkeRHC&SQZAHDlu1uD6Ex^Djp=4o4=KYeGoxlm$8=F~o^fB#%FqdW+(`o= zU|Q?U^}SKwizs`!4vE!b>{Tll8K$PVNfbAbw4#`l6(x+mx~ljmK3*7^bOgBgkKbkX zONk&PDF~c))gVBlodLlU5H@ZgiSQsn%7nbHzekr?V@xgx0Z~&GODPk){+zJT5S|6K z5^F(%wSW`y(2P9Rok<8Gz(<-jfJMC!T+2enY+>W5;Czyd1j?E`BT*`_I!rDI0SQum zHuN!I!A%yJg*9O7a29d4dCuFuz>qBj_CQ8Su`we3CK<#D)}5c$czUQ{H;VaE%W|>W z$IYlp7;oyB=~W3msAEQ+N|^m9^EIqZ?T4qpEZ( zw^H*-xo=TgEyKRD22YueTkJQ6G1V?iWgF6dfL_w{p2$yu0Rr;@y`t_FD5LWL`l2&BIOa z$K~cl!Z862ou%`ddkgpJgf0@*PkMPnx6-YB)plD)n7{CPA1+^pIsG%dV<{dX^$<*h z1e8R=Y>*kFZCV>Wpp^LpCi+}c)B7>I(h;0%K+Ck1T|>UD2x$u}0+9HcFgobY!K>`H z6JlP&3Posq{MPD1r9YKtuIGo)QyVIV^ww>X?j1mWPlR_WF}KQ zi9QHy*p4sh0QrhPxzSL6o!=z&V^f>k(UXPeCv#%KEh+$>kO4bGJG&-3&^Fl@mL}2?8)?#8YJTFCpnJ29#Kz+mVQmynJ^!j6sxIy!IK^AOO z@Jv`FFh3K+Ucuxzb_exUP3}F7SKkElx_k%$Q}d!dPCItjYtO;_>hKn=@J7;MF7g1M=;g2k7yy>ExbS7lx(DMNZ9>AgIEVjNg z82&U;Gkn%bX_bMxxyuV7_^Yr-TMfq%6tiSakl9Xviy3zS|}Qyw6P*+ zS$d@DJ<)O2|Mastg>9W6xay~9FEK`iqk#whH2@{C_p0K+rt#-3L%AQAUpzI>=nYLZ(xK19U+Rw z;wh36hC$tZ5!{QQiKfVKl)AdZ)Y%2XN#Bt7@+K8gk!{Ck#Dfda) z`uYawt=}9XKO(8>iV|9~q@Fw;H#Ik(rSt8*$a|=?qzFgm8ghF*^wFVXG^c7dm6n!> z#<<`;S%Bu#0XoQ`TRP5N+p{<;6r;c!In*>_O83m51e@4kmN!+K~4 zV?_8G(dSwN`iC2z)pP5Yqt9}^;ZGOn*o!{>?sxo}s#fXk+jr`CBB8^PkPd|hB@IQw zIu?)WmtJ}qedg(fOIGVeOIB^?d584dwSeQ?{cD_f(&~fAoD9@iq z;c%GFwzg7FZx2;g%%(5?(F63w2iD_B?JR*jQz@KQknis4r9hyKdVBh*Ag_SD9v^jd zbW<>J9$MH(g;TxcLKmf#V-s-d17_G)kYSR??V(_6kUsO-2Wj5C273DGf2EO;7}eF+ z(wbX8O`Cr73);PBFU_1egVx{mDSF~>zCtx~s_E#_+$uc*bN$Ky0>)>ZWNZ~O&q z+Vr3F&_fT3^Lg!8zorBGc9VZfJ-zVa8?<-N9;o#!np0atO@|KCFaGy+jKH5EU1EQX zKe&A@{p8ta=-c1^Tbd7TI@Hueue`b$cf5EO3uj9O8rZQi_`JaL;6H9R>Rf(Y$B2^b zloL)(pfi0)KGj8IG1y-_Y%)Nd9i6Nfv}n-+D!;0p%FDdedS)-Zy=5zfVB-lRLEE-% z!|K07RkhPF!f2?}+uJ98Bp3)%G#aIuGp5ths~6&q2~rc}bthnQXl)b5;AoRevdo+@ z6JnZau!05$a6|yY9`ULSUO8Tgj`j|E>Zzw`$>POue&3?OP?%P&zLEa$lQ&Y}ob|Q6 z<;*#8a*@a|ojn(jIAEEPY?bH@*gD*fhOJ(-Tl_H$(0(o5&g6Z%o zMq^PrcH#tW-1sa#^URANaV8ad71cp0%5W0lZpp(_C^SR?jCuZihitzjyMuKPGz^0U z$0p$TeZZ{B#@CgmPq{rV?e}|8&7Ry^<=*}Xb+$6HUcXHT)GV%_t>Bshpd7%k?I z9M6l8*ezizKLa)l;Z7bqFZbp&%p?zPSW_E2Kd$q5T-g3N6vwzYKUfB50p_vgOT7}G`Z+Mx@Dbxc4-MdN2N`l|^TS~PB=+S-b^w;O`y`LOC~+i$X895Fr< z;Df;OUXbgNm=Hr$dbE$v>lRcyI3{3r9LT#T5tAT`ena6Jc2V}OR@3X()j0Jd>yG5)+$V4sA* zz%Eh5Wm4IR;~&UJ)LgPL9Qgo7Ti`H4GxHI=@? z+1hU&tjcj9ZD2oGNwm^`nH1hB923C6LE~qbN*A)ce!K_C1hRoupZ{F|^b-PekYH_V zS;iOz+%x1ibQpi0v+Eqgu?ZwmQMu%1aGiSp&b_$}+jll3N4UTwP!ux~gU=3jl6<;(R{Ab`SZ^e#q2e@43 zgWu*h7fk>Iw)PkVKV%oh_p=RZ{y9MwLAcSls?4(U3sUJfeqRQ^aprFZmQN6HV=f#; z_ED+H09HJTy-DFZHeo0A+5=q@0fFG*2QkHw!yQLtS#u_6- ziEV~K%{r|9xId_Zpa}>pF$G`KQ=ziLhf5-W(H3kvgH>OOERHOr;7LyORhVnX*96qs zugbHL#Nc7k1SftKg8x|9d}?2-ed_{1P?KX)7BWSGRd$29LT+=(1TccZ!{}roaZDrLO?b16kD{pWJO7F|z=^)qv1?jPQKLaRz6rA!);ZE(gKD(SAJR zTFmOd?J7J%0RNVQ1iqJfU+VaCIViI3jcI_vpU1v&ZA-Pu@tj(aaTg~49P(l8V>psoJEomdK&^uN17~udYuLO07q06;Lhae+{Tt4Fe9+OV zrvt)8A+Y?~fCU#{!1cK1YwF`R7aa*+3MwlX7vd?kFv%6#{U9 zWMUSC`W)nEq-y~FV*Sf0R`&11krW~RFD)5 zNvGvG$$J3F+gBEzRi6P{>-8ISJ2c?H754$ZYj`x3La5aCmJ~RZAm0VT&IukWQmaOYUV@Nu zkl@1#k3d*{B|D5f`v$J}ARmL^ES!newq6|DCqSUzW75Or{rc>rBY<(DNY&RU>S-q` zor-{FP*F*Nra?&TM>!I6k=w5+hBLC4Nk9-14}lz9`3FfH9VS#riwR6h0fZ_002ovPDHLkV1n9f@1Otx literal 0 HcmV?d00001 diff --git a/docs/assets/js/theme.js b/docs/assets/js/theme.js new file mode 100644 index 00000000..8fb56af6 --- /dev/null +++ b/docs/assets/js/theme.js @@ -0,0 +1,162 @@ +/* +================================================================ +* Template: iDocs - One Page Documentation HTML Template +* Written by: Harnish Design - (http://www.harnishdesign.net) +* Description: Main Custom Script File +================================================================ +*/ + + +(function ($) { + "use strict"; + +// Preloader +$(window).on('load', function () { + $('.lds-ellipsis').fadeOut(); // will first fade out the loading animation + $('.preloader').delay(333).fadeOut('slow'); // will fade out the white DIV that covers the website. + $('body').delay(333); +}); + +/*------------------------------- + Primary Menu +--------------------------------- */ + +// Dropdown show on hover +$('.primary-menu ul.navbar-nav li.dropdown, .login-signup ul.navbar-nav li.dropdown').on("mouseover", function() { + if ($(window).width() > 991) { + $(this).find('> .dropdown-menu').stop().slideDown('fast'); + $(this).bind('mouseleave', function() { + $(this).find('> .dropdown-menu').stop().css('display', 'none'); + }); + } +}); + +// When dropdown going off to the out of the screen. +$('.primary-menu ul.navbar-nav .dropdown-menu').each(function() { + var menu = $('#header .container-fluid').offset(); + var dropdown = $(this).parent().offset(); + + var i = (dropdown.left + $(this).outerWidth()) - (menu.left + $('#header .container-fluid').outerWidth()); + + if (i > 0) { + $(this).css('margin-left', '-' + (i + 5) + 'px'); + } + }); +$(function () { + $(".dropdown li").on('mouseenter mouseleave', function (e) { + if ($(window).width() > 991) { + var elm = $('.dropdown-menu', this); + var off = elm.offset(); + var l = off.left; + var w = elm.width(); + var docW = $(window).width(); + var isEntirelyVisible = (l + w + 30 <= docW); + if (!isEntirelyVisible) { + $(elm).addClass('dropdown-menu-right'); + } else { + $(elm).removeClass('dropdown-menu-right'); + } + } + }); +}); + +// DropDown Arrow +$('.primary-menu ul.navbar-nav').find('a.dropdown-toggle').append($('').addClass('arrow')); + + +// Mobile Collapse Nav +$('.primary-menu .navbar-nav .dropdown-toggle[href="#"], .primary-menu .dropdown-toggle[href!="#"] .arrow').on('click', function(e) { + if ($(window).width() < 991) { + e.preventDefault(); + var $parentli = $(this).closest('li'); + $parentli.siblings('li').find('.dropdown-menu:visible').slideUp(); + $parentli.find('> .dropdown-menu').stop().slideToggle(); + $parentli.siblings('li').find('a .arrow.show').toggleClass('show'); + $parentli.find('> a .arrow').toggleClass('show'); + } +}); + + +// Mobile Menu +$('.navbar-toggler').on('click', function() { + $(this).toggleClass('show'); +}); + + +/*------------------------ + Side Navigation +-------------------------- */ + +$('#sidebarCollapse').on('click', function () { + $('#sidebarCollapse span:nth-child(3)').toggleClass('w-50'); + $('.idocs-navigation').toggleClass('active'); +}); + + +/*------------------------ + Sections Scroll +-------------------------- */ + +$('.smooth-scroll,.idocs-navigation a').on('click', function() { + event.preventDefault(); + var sectionTo = $(this).attr('href'); + $('html, body').stop().animate({ + scrollTop: $(sectionTo).offset().top - 120}, 1000, 'easeInOutExpo'); +}); + +/*----------------------------- + Magnific Popup +------------------------------- */ + +// Image on Modal +$('.popup-img').each(function() { +$(this).magnificPopup({ + type: "image", + tLoading: '
', + closeOnContentClick: !0, + mainClass: "mfp-fade", + +}); +}); + +// YouTube/Viemo Video & Gmaps +$('.popup-youtube, .popup-vimeo, .popup-gmaps').each(function() { +$(this).magnificPopup({ + type: 'iframe', + mainClass: 'mfp-fade', +}); +}); + + +/*------------------------ + Highlight Js +-------------------------- */ + +hljs.initHighlightingOnLoad(); + + +/*------------------------ + tooltips +-------------------------- */ +$('[data-toggle=\'tooltip\']').tooltip({container: 'body'}); + + +/*------------------------ + Scroll to top +-------------------------- */ +$(function () { + $(window).on('scroll', function(){ + if ($(this).scrollTop() > 400) { + $('#back-to-top').fadeIn(); + } else { + $('#back-to-top').fadeOut(); + } + }); + }); +$('#back-to-top').on("click", function() { + $('html, body').animate({scrollTop:0}, 'slow'); + return false; +}); + + +})(jQuery) \ No newline at end of file diff --git a/docs/assets/sass/_elements.scss b/docs/assets/sass/_elements.scss new file mode 100644 index 00000000..397f710a --- /dev/null +++ b/docs/assets/sass/_elements.scss @@ -0,0 +1,537 @@ +/* =================================== */ +/* 5. Elements +/* =================================== */ + +/*=== 5.1 List Style ===*/ + +.list-style-1 > li { + position: relative; + list-style-type: none; + line-height: 24px; + &:after { + content: " "; + position: absolute; + top: 12px; + left: -15px; + border-color: #000; + border-top: 1px solid; + border-right: 1px solid; + width: 6px; + height: 6px; + -webkit-transform: translate(-50%, -50%) rotate(45deg); + transform: translate(-50%, -50%) rotate(45deg); + } +} + +.list-style-2{padding:0;} + +.list-style-2 > li { + list-style-type: none; + border-bottom: 1px solid #eaeaea; + padding-top: 12px; + padding-bottom: 12px; +} +.list-style-2.list-style-light > li { + border-bottom: 1px solid rgba(250,250,250,0.12); +} + +/*=== 5.2 Changelog ===*/ + +.changelog { + list-style: none; + padding: 0; + .badge { + width: 90px; + margin-right: 10px; + border-radius: .20rem; + text-transform: uppercase; + } + li { + line-height: 1.8; + } +} + + +/*=== 5.3 Accordion & Toggle ===*/ +.accordion { + .card { + border: none; + margin-bottom: 16px; + margin-bottom: 1rem; + background-color: transparent; + } + .card-header { + padding: 0; + border: none; + background: none; + a { + font-size: 16px; + font-weight:normal; + padding: 1rem 1.25rem 1rem 2.25rem; + display: block; + border-radius: 4px; + position: relative; + &:hover{ + text-decoration:none; + } + &:hover.collapsed { + color: $primary-color!important; + } + } + } + &:not(.accordion-alternate) .card-header a { + background-color: $primary-color; + color: #fff; + &.collapsed { + background-color: #f1f2f4; + color: #4c4d4d; + } + + } + .card-header a { + &:before { + position: absolute; + content: " "; + left: 20px; + top: calc(50% + 2px); + width: 9px; + height: 9px; + border-color: #CCC; + border-top: 2px solid; + border-right: 2px solid; + -webkit-transform: translate(-50%, -50%) rotate(-45deg); + transform: translate(-50%, -50%) rotate(-45deg); + @include transition(all 0.2s ease); + -webkit-backface-visibility: hidden; + backface-visibility: hidden; + } + &.collapsed:before { + top: calc(50% - 2px); + -webkit-transform: translate(-50%, -50%) rotate(135deg); + transform: translate(-50%, -50%) rotate(135deg); + } + } + .card-body { + line-height: 26px; + } + &.arrow-right .card-header a{ + padding-left:1.25rem; + &:before { + right: 15px; + left: auto; + } + } + &.accordion-alternate { + .card { + margin: 0; + } + .card-header a { + padding-left: 1.40rem; + border-top: 1px solid #e4e9ec; + border-radius: 0px; + } + .card:first-of-type .card-header a { + border-top: 0px; + } + .card-header a { + &:before { + left: 6px; + } + &.collapsed { + color: #4c4d4d; + } + } + .card-body { + padding: 0rem 0 1rem 1.25rem; + } + &.arrow-right .card-header a{ + padding-left:0; + &:before { + right: 0px; + left: auto; + } + } + + } + &.toggle .card-header a { + &:before { + content: "-"; + border: none; + font-size: 20px; + height: auto; + top: calc(50% + 2px); + width: auto; + -webkit-transform: translate(-50%, -50%) rotate(180deg); + transform: translate(-50%, -50%) rotate(180deg); + } + &.collapsed:before { + content: "+"; + top: calc(50% - 1px); + -webkit-transform: translate(-50%, -50%) rotate(0deg); + transform: translate(-50%, -50%) rotate(0deg); + } + } + &.accordion-alternate.style-2 { + .card-header a { + &:before { + right: 2px; + left: auto; + -webkit-transform: translate(-50%, -50%) rotate(135deg); + transform: translate(-50%, -50%) rotate(135deg); + top: 50%; + } + &.collapsed:before { + -webkit-transform: translate(-50%, -50%) rotate(45deg); + transform: translate(-50%, -50%) rotate(45deg); + } + padding-left: 0px; + } + .card-body { + padding-left: 0px; + } + } + &.accordion-alternate.popularRoutes { + .card-header { + .nav { + margin-top: 3px; + a { + font-size: 14px; + } + } + a { + padding: 0px 8px 0px 0px; + border: none; + font-size: inherit; + &:before { + content: none; + } + } + h5 { + cursor: pointer; + &:before { + position: absolute; + content: " "; + right: 0px; + top: 24px; + width: 10px; + height: 10px; + opacity: 0.6; + border-top: 2px solid; + border-right: 2px solid; + -webkit-transform: translate(-50%, -50%) rotate(-45deg); + transform: translate(-50%, -50%) rotate(-45deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + -webkit-backface-visibility: hidden; + backface-visibility: hidden; + } + &.collapsed:before { + top: 24px; + -webkit-transform: translate(-50%, -50%) rotate(135deg); + transform: translate(-50%, -50%) rotate(135deg); + } + } + } + .card-body { + padding: 0; + } + .card { + border-bottom: 2px solid #e4e9ec; + padding: 15px 0px; + } + .routes-list { + margin: 1rem 0px 0px 0px; + padding: 0px; + list-style: none; + a { + color: inherit; + display: -ms-flexbox !important; + display: flex !important; + -ms-flex-align: center !important; + align-items: center !important; + &:hover { + color: #0071cc; + text-decoration: underline; + } + } + } + } +} + +/* 5.4 Nav */ + +.nav .nav-item .nav-link{color: #222222;} +.nav.nav-light .nav-item .nav-link{color: #ddd;} +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover{color: $primary-color;} + + +.nav-pills .nav-link:not(.active):hover{color: $primary-color;} +.nav-pills .nav-link.active,.nav-pills.nav-light .nav-link.active, .nav-pills .show > .nav-link{color:#fff;} + +.nav.nav-separator .nav-item .nav-link{position:relative;} +.nav.nav-separator .nav-item + .nav-item .nav-link:after{ + height: 14px; + width: 1px; + content: ' '; + background-color: rgba(0,0,0,0.2); + display: block; + position: absolute; + top: 50%; + left: 0; + @include translateY(-7px); +} +.nav.nav-separator.nav-separator-light .nav-item + .nav-item .nav-link:after{ +background-color: rgba(250,250,250,0.2); +} + +.nav.nav-sm .nav-item .nav-link{font-size:14px;} + + +/*=== 5.5 Tabs ===*/ + +.nav-tabs { + border-bottom: 1px solid #d7dee3; + .nav-item .nav-link { + border:0; + background: transparent; + + position: relative; + border-radius: 0; + padding:0.6rem 1rem; + color: #7b8084; + white-space: nowrap !important; + &.active { + &:after { + height: 2px; + width: 100%; + content: ' '; + background-color: $primary-color; + display: block; + position: absolute; + bottom: -3px; + left: 0; + @include translateY(-3px); + } + color: #0c2f55; + } + &:not(.active):hover { + color: $primary-color; + } + } + &.flex-column { + border-right: 1px solid #d7dee3; + border-bottom: 0px; + padding: 1.5rem 0; + .nav-item { + .nav-link { + border: 1px solid #d7dee3; + border-right: 0px; + background-color: #f6f7f8; + font-size: 14px; + padding: 0.75rem 1rem; + color: #535b61; + } + &:first-of-type .nav-link { + border-top-left-radius: 4px; + } + &:last-of-type .nav-link { + border-bottom-left-radius: 4px; + } + .nav-link.active { + &:after { + height: 100%; + width: 2px; + background: #fff; + right: -1px; + left: auto; + } + background-color: transparent; + color: $primary-color; + } + } + } +} + +.nav-tabs:not(.flex-column) { + .nav-item { + margin-bottom: 0px; + } + flex-wrap: nowrap; + overflow: hidden; + overflow-x: auto; + -ms-overflow-style: -ms-autohiding-scrollbar; + -webkit-overflow-scrolling: touch; +} + + + +@include media-breakpoint-down(xs) { + .nav-tabs .nav-item .nav-link { + padding-left: 0px; + padding-right: 0px; + margin-right: 10px; + font-size: 0.875rem; + } +} + + +/*=== 5.6 Popup Img ===*/ +.popup-img img{@include transition(all 0.2s ease-in-out);} +.popup-img:hover img{ + opacity:0.8; + cursor: -webkit-zoom-in; + cursor: -moz-zoom-in; + cursor: zoom-in; +} + + +/*=== 5.7 Featured Box ===*/ +.featured-box { + box-sizing: border-box; + position: relative; + h3, h4 { + font-size: 1.25rem; + font-size: 20px; + margin-bottom: 10px; + font-weight: 500; + } + &:not(.style-5) .featured-box-icon { + display: inline-block; + font-size: 48px; + min-width: 55px; + min-height: 55px; + padding: 0; + margin-top: 0; + margin-bottom: 0.8rem; + color: #4c4d4d; + border-radius: 0; + } + &.style-1, &.style-2, &.style-3 { + padding-left: 50px; + padding-top: 8px; + } + &.style-1 .featured-box-icon, &.style-2 .featured-box-icon, &.style-3 .featured-box-icon { + position: absolute; + top: 0; + left: 0; + margin-bottom: 0; + font-size: 30px; + -ms-flex-pack: center !important; + justify-content: center !important; + text-align: center; + } + &.style-2 p { + margin-left: -50px; + } + &.style-3 { + padding-left: 90px; + padding-top: 0px; + .featured-box-icon { + width: 70px; + height: 70px; + -ms-flex-negative: 0; + flex-shrink: 0; + display: -webkit-box; + display: -ms-flexbox; + display: flex; + -webkit-box-align: center; + -ms-flex-align: center; + align-items: center; + } + } + &.style-4 { + text-align: center; + .featured-box-icon { + margin: 0 auto 24px; + margin: 0 auto 1.5rem; + width: 120px; + height: 120px; + text-align: center; + -ms-flex-negative: 0; + flex-shrink: 0; + display: -webkit-box; + display: -ms-flexbox; + display: flex; + -webkit-box-align: center; + -ms-flex-align: center; + align-items: center; + -ms-flex-pack: center; + justify-content: center; + @include box-shadow(0px 0px 50px rgba(0, 0, 0, 0.03)); + } + } + + &.style-5 { + text-align: center; + background: #fff; + border: 1px solid #f0f2f3; + @include box-shadow(0px 2px 5px rgba(0, 0, 0, 0.05)); + @include transition(all 0.3s ease-in-out); + &:hover { + border: 1px solid #ebeded; + @include box-shadow(0px 5px 1.5rem rgba(0, 0, 0, 0.15)); + } + h3 { + background: #f1f5f6; + font-size: 16px; + padding: 8px 0; + margin-bottom: 0px; + } + .featured-box-icon { + font-size: 50px; + margin: 44px 0px; + } +} +} + + +@mixin featured-box-reverse { + text-align:right; + &.style-1, &.style-2{ + padding-right:50px; + padding-left:0px; + .featured-box-icon{ + left:auto; + right:0px; + } + } + &.style-2 p{ + margin-right: -50px; + margin-left:0; + } + &.style-3{ + padding-left:0; + padding-right:90px; + .featured-box-icon{ + left:auto; + right:0px; + } + } +} + +.featured-box.featured-box-reverse{ + @include featured-box-reverse; +} + +@include media-breakpoint-up(xs) { + .featured-box.featured-box-reverse-sm{ + @include featured-box-reverse; + } +} + +@include media-breakpoint-up(sm) { + .featured-box.featured-box-reverse-md{ + @include featured-box-reverse; + } +} + +@include media-breakpoint-up(md) { + .featured-box.featured-box-reverse-lg{ + @include featured-box-reverse; + } +} +@include media-breakpoint-up(lg) { + .featured-box.featured-box-reverse-xl{ + @include featured-box-reverse; + } +} \ No newline at end of file diff --git a/docs/assets/sass/_extras.scss b/docs/assets/sass/_extras.scss new file mode 100644 index 00000000..c07f2098 --- /dev/null +++ b/docs/assets/sass/_extras.scss @@ -0,0 +1,448 @@ +/* =================================== */ +/* Extras +/* =================================== */ + +/* Bootstrap Specific */ + +.form-control, .custom-select { + border-color: #dae1e3; + font-size: 16px; + color: #656565; +} + +.form-control:not(.form-control-sm) { + padding: .810rem .96rem; + height:inherit; +} + +.form-control-sm{font-size:14px;} + +.icon-inside { + position: absolute; + right: 15px; + top: calc(50% - 11px); + pointer-events: none; + font-size: 18px; + font-size: 1.125rem; + color: #c4c3c3; + z-index:3; +} +.form-control-sm + .icon-inside { + font-size: 0.875rem !important; + font-size: 14px; + top: calc(50% - 13px); +} + +select.form-control:not([size]):not([multiple]):not(.form-control-sm) { + height: auto; + padding-top: .700rem; + padding-bottom: .700rem; +} +.custom-select:not(.custom-select-sm){ + height:calc(3.05rem + 2px); + padding-top: .700rem; + padding-bottom: .700rem;} +.col-form-label-sm{font-size:13px;} +.custom-select-sm{padding-left:5px!important; font-size:14px;} +.custom-select:not(.custom-select-sm).border-0{height:3.00rem;} + +.form-control:focus, .custom-select:focus{ + @include box-shadow(0 0 5px rgba(128, 189, 255, 0.5)); +} +.form-control:focus[readonly]{box-shadow:none;} + +.input-group-text { + border-color: #dae1e3; + background-color:#f1f5f6; + color: #656565; +} + +.form-control { + &::-webkit-input-placeholder { + color: #b1b4b6; + } + &:-moz-placeholder { + /* FF 4-18 */ + color: #b1b4b6; + } + &::-moz-placeholder { + /* FF 19+ */ + color: #b1b4b6; + } + &:-ms-input-placeholder, &::-ms-input-placeholder { + /* IE 10+ */ + color: #b1b4b6; + } +} + +/* Form Dark */ +.form-dark { + .form-control, .custom-select { + border-color: #232a31; + background:#232a31; + color: #fff; + } + .form-control:focus{border-color: #80bdff!important;} + .form-control { + &::-webkit-input-placeholder { + color: #777b7f; + } + &:-moz-placeholder { + /* FF 4-18 */ + color: #777b7f; + } + &::-moz-placeholder { + /* FF 19+ */ + color: #777b7f; + } + &:-ms-input-placeholder, &::-ms-input-placeholder { + /* IE 10+ */ + color: #777b7f; + } + } + .custom-select { + color: #777b7f; + background: url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 4 5'%3E%3Cpath fill='rgba(250,250,250,0.3)' d='M2 0L0 2h4zm0 5L0 3h4z'/%3E%3C/svg%3E") no-repeat right 0.75rem center; + background-size: 13px 15px; + border-color: #232a31; + background-color:#232a31; + } + .icon-inside { + color: #777b7f; + } +} + +/* Input with only bottom border */ +.form-border { + .form-control { + background-color: transparent; + border: none; + border-bottom: 2px solid rgba(0, 0, 0, 0.12); + border-radius: 0px; + padding-left: 0px!important; + color: rgba(0, 0, 0, 1); + &::-webkit-input-placeholder { + color: rgba(0, 0, 0, 0.4); + } + &:-moz-placeholder { + /* FF 4-18 */ + color: rgba(0, 0, 0, 0.4); + } + &::-moz-placeholder { + /* FF 19+ */ + color: rgba(0, 0, 0, 0.4); + } + &:-ms-input-placeholder, &::-ms-input-placeholder { + /* IE 10+ */ + color: rgba(0, 0, 0, 0.4); + } + } + .custom-select { + background-color: transparent; + border: none; + border-bottom: 2px solid rgba(0, 0, 0, 0.12); + border-radius: 0px; + padding-left: 0px; + color: rgba(0, 0, 0, 0.4); + background: url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 4 5'%3E%3Cpath fill='rgba(0,0,0,0.3)' d='M2 0L0 2h4zm0 5L0 3h4z'/%3E%3C/svg%3E") no-repeat right 0.75rem center; + background-size: 13px 15px; + } + .form-control:focus, .custom-select:focus { + box-shadow: none; + -webkit-box-shadow: none; + border-bottom: 2px solid rgba(0, 0, 0, 0.7); + } + .form-control:not(output):-moz-ui-invalid, .custom-select:not(output):-moz-ui-invalid { + &:not(:focus), &:-moz-focusring:not(:focus) { + border-bottom: 2px solid #b00708; + box-shadow: none; + -webkit-box-shadow: none; + } + } + .icon-inside { + color: rgba(0, 0, 0, 0.25); + } + select option { + color: #666; + } +} + +.form-border-light { + .form-control { + border-bottom: 2px solid rgba(250, 250, 250, 0.3); + color: rgba(250, 250, 250, 1); + &::-webkit-input-placeholder { + color: rgba(250, 250, 250, 0.7); + } + &:-moz-placeholder { + /* FF 4-18 */ + color: rgba(250, 250, 250, 0.7); + } + &::-moz-placeholder { + /* FF 19+ */ + color: rgba(250, 250, 250, 0.7); + } + &:-ms-input-placeholder, &::-ms-input-placeholder { + /* IE 10+ */ + color: rgba(250, 250, 250, 0.7); + } + } + .custom-select { + border-bottom: 2px solid rgba(250, 250, 250, 0.3); + color: rgba(250, 250, 250, 1); + background: url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 4 5'%3E%3Cpath fill='rgba(250,250,250,0.6)' d='M2 0L0 2h4zm0 5L0 3h4z'/%3E%3C/svg%3E") no-repeat right 0.75rem center; + background-size: 13px 15px; + } + .form-control:focus, .custom-select:focus { + border-bottom: 2px solid rgba(250, 250, 250, 0.8); + } + .icon-inside { + color: #999; + } + select option { + color: #333; + } +} + +.input-group-append .btn, .input-group-prepend .btn { + @include box-shadow(none); + padding-left: 0.75rem; + padding-right: 0.75rem; +} + +.input-group-append .btn:hover, .input-group-prepend .btn:hover { + @include box-shadow(none); +} + +@include media-breakpoint-down(xs) { + .input-group > { + .input-group-append > .btn, .input-group-prepend > .btn { + padding: 0 0.75rem; + } +} +} + +.bg-primary, .badge-primary { + background-color: $primary-color !important; +} +.bg-secondary { + background-color: $secondary-color !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: $primary-color !important; +} + +.btn-link:hover { + color: $primary-color-hover !important; +} +.text-secondary{ + color: $secondary-color !important; +} + +.text-light{ + color:#dee3e4!important; +} +.text-body{ + color: $text-color !important; +} +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover{background-color: $primary-color-hover!important;} + +.border-primary { + border-color: $primary-color !important; +} +.border-secondary { + border-color: $secondary-color !important; +} + +.btn-primary{ + background-color: $primary-color; + border-color: $primary-color; + &:hover { + background-color: $primary-color-hover; + border-color: $primary-color-hover; + } +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active{ + background-color: $primary-color-hover; + border-color: $primary-color-hover; + +} + +.btn-primary.focus, .btn-primary:focus{ + background-color: $primary-color-hover; + border-color: $primary-color-hover; +} + +.btn-primary:not(:disabled):not(.disabled).active:focus, .btn-primary:not(:disabled):not(.disabled):active:focus, .show > .btn-primary.dropdown-toggle:focus{ + @include box-shadow(none); +} + +.btn-secondary { + background-color: $secondary-color; + border-color: $secondary-color; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active{ + color: $primary-color; + border-color: $primary-color; + &:hover { + background-color: $primary-color; + border-color: $primary-color; + color: #fff; + } +} + +.btn-outline-secondary{ + color: $secondary-color; + border-color: $secondary-color; + &:hover { + background-color: $secondary-color; + border-color: $secondary-color; + color: #fff; + } +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active{ + background-color: $primary-color; +} +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before{ + background-color: $primary-color; + border-color: $primary-color; +} +.list-group-item.active{ + background-color: $primary-color; + border-color: $primary-color; +} +.page-link { + color: $primary-color; + &:hover { + color: $primary-color-hover; + } +} + +/* Pagination */ + +.page-link { + border: none; + border-radius: 0.25rem; + margin: 0 0.22rem; + font-size: 16px; + font-size: 1rem; + &:hover { + background-color: #e9eff0; + } +} + +/* Vertical Multilple input group */ + +.vertical-input-group .input-group { + &:first-child { + padding-bottom: 0; + * { + border-bottom-left-radius: 0; + border-bottom-right-radius: 0; + } + } + &:last-child { + padding-top: 0; + * { + border-top-left-radius: 0; + border-top-right-radius: 0; + } + } + &:not(:last-child):not(:first-child) { + padding-top: 0; + padding-bottom: 0; + * { + border-radius: 0; + } + } + &:not(:first-child) * { + border-top: 0; + } +} + +/* styles-switcher */ +#styles-switcher { + background: #fff; + width: 202px; + position: fixed; + top: 35%; + z-index: 99; + padding: 20px; + left: -202px; + ul { + padding: 0; + li { + list-style-type: none; + width: 25px; + height: 25px; + margin: 4px 2px; + border-radius: 50%; + display: inline-block; + cursor: pointer; + transition: all .2s ease-in-out; + &.blue { + background: #007bff; + } + &.brown { + background: #795548; + } + &.purple { + background: #6f42c1; + } + &.indigo { + background: #6610f2; + } + &.red { + background: #dc3545; + } + &.orange { + background: #fd7e14; + } + &.yellow { + background: #ffc107; + } + &.green { + background: #28a745; + } + &.teal { + background: #20c997; + } + &.cyan { + background: #17a2b8; + } + &.active { + transform: scale(0.7); + cursor:default; + } + } + } + .switcher-toggle { + position: absolute; + background: #333; + color: #fff; + font-size: 1.25rem; + border-radius: 0px 4px 4px 0; + right: -40px; + top: 0; + width: 40px; + height: 40px; + padding: 0; + } + #reset-color{background: #e83e8c;} +} + +input:-internal-autofill-selected { + background-color: transparent; +} + +#styles-switcher.right{left:auto; right: -202px;} +#styles-switcher.right .switcher-toggle{right: auto; left: -40px; border-radius: 4px 0px 0px 4px;} \ No newline at end of file diff --git a/docs/assets/sass/_footer.scss b/docs/assets/sass/_footer.scss new file mode 100644 index 00000000..44ee02c7 --- /dev/null +++ b/docs/assets/sass/_footer.scss @@ -0,0 +1,188 @@ +/* =================================== */ +/* 6. Footer +/* =================================== */ + +#footer { + background: #fff; + color: #252b33; + margin-left:260px; + padding: 66px 0px; + padding: 4.125rem 0; + .nav { + .nav-item { + display: inline-block; + line-height: 12px; + margin: 0; + .nav-link { + color: #252b33; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + &:focus { + color: $primary-color; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + } + } + &:first-child .nav-link { + padding-left: 0px; + } + &:last-child .nav-link{ + padding-right: 0px; + } + } + .nav-link:hover { + color: $primary-color; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + } + } + .footer-copyright { + border-top: 1px solid #e2e8ea; + padding: 0px 0px; + color: #67727c; + .nav { + .nav-item .nav-link { + color: #67727c; + } + .nav-link:hover { + color: $primary-color; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + } + } + } + .nav.flex-column .nav-item { + padding: 0px; + .nav-link { + margin: 0.7rem 0px; + } + } + &.footer-text-light { + color: rgba(250, 250, 250, 0.8); + .nav .nav-item .nav-link { + color: rgba(250, 250, 250, 0.8); + &:hover { + color: rgba(250, 250, 250, 1); + } + } + .footer-copyright { + border-color: rgba(250, 250, 250, 0.15); + color: rgba(250, 250, 250, 0.5); + } + &:not(.bg-primary) .social-icons-light.social-icons li a { + color: rgba(250, 250, 250, 0.8); + &:hover { + color: rgba(250, 250, 250, 1); + } + } + &.bg-primary { + color: #fff; + .nav .nav-item .nav-link { + color: #fff; + &:hover { + color: rgba(250, 250, 250, 0.7); + } + } + .footer-copyright { + border-color: rgba(250, 250, 250, 0.15); + color: rgba(250, 250, 250, 0.9); + } + :not(.social-icons) a { + color: #fff; + &:hover { + color: rgba(250, 250, 250, 0.7); + } + } + } + } +} + +@include media-breakpoint-down(sm) { +#footer { + margin-left:0px; +} +} + + +/*=== 6.1 Social Icons ===*/ +.social-icons { + margin: 0; + padding: 0; + display: -ms-flexbox; + display: flex; + -ms-flex-wrap: wrap; + flex-wrap: wrap; + list-style: none; + li { + margin: 0px 6px; + padding: 0; + overflow: visible; + a { + display: block; + height: 26px; + line-height: 26px; + width: 26px; + font-size: 18px; + text-align: center; + color: #4d555a; + text-decoration: none; + @include transition(all 0.2s ease); + } + i { + line-height: inherit; + } + } + &.social-icons-sm li{ + margin: 0px 4px; + } + &.social-icons-sm li a { + font-size: 15px; + width:22px; + } + &.social-icons-lg li a { + width: 34px; + height: 34px; + line-height:34px; + font-size: 22px; + } + &.social-icons-light li a { + color: #eee; + } + &.social-icons-muted li a { + color: #aab1b8; + } + li:hover { + a { + color: #999; + } + } +} + + +/*=== 6.2 Back to Top ===*/ +#back-to-top { + display: none; + position: fixed; + z-index: 1030; + bottom: 8px; + right: 10px; + background-color: rgba(0, 0, 0, 0.22); + text-align: center; + color: #fff; + font-size: 14px; + width: 36px; + height: 36px; + line-height: 34px; + border-radius:3px; + @include transition(all 0.3s ease-in-out); + @include box-shadow(0px 5px 15px rgba(0, 0, 0, 0.15)); + &:hover { + background-color: $primary-color; + @include box-shadow(0px 5px 15px rgba(0, 0, 0, 0.25)); + @include transition(all 0.3s ease-in-out); + } +} + +@include media-breakpoint-down(xs) { + #back-to-top {z-index: 1029;} +} \ No newline at end of file diff --git a/docs/assets/sass/_header.scss b/docs/assets/sass/_header.scss new file mode 100644 index 00000000..6b003288 --- /dev/null +++ b/docs/assets/sass/_header.scss @@ -0,0 +1,554 @@ +/* =================================== */ +/* 4. Header +/* =================================== */ + +#header { + @include transition(all .5s ease); + .navbar { + padding: 0px; + min-height:70px; + } + .logo { + -webkit-box-align: center; + -ms-flex-align: center; + align-items: center; + display: -webkit-box; + display: -ms-flexbox; + display: flex; + -ms-flex-item-align: stretch; + align-self: stretch; + } +} + + +/*=== 4.1 Main Navigation ===*/ + +.navbar-light .navbar-nav { + .active > .nav-link { + color: #0c2f55; + } + .nav-link { + &.active, &.show { + color: #0c2f55; + } + } + .show > .nav-link { + color: #0c2f55; + } +} + +.primary-menu { + display: -webkit-box !important; + display: -ms-flexbox !important; + display: flex !important; + height: auto !important; + -webkit-box-ordinal-group: 0; + -ms-flex-item-align: stretch; + align-self: stretch; + background: #fff; + border-bottom:1px solid #efefef; + &.bg-transparent { + position: absolute; + z-index: 999; + top: 0; + left: 0; + width: 100%; + box-shadow: none; + border-bottom: 1px solid rgba(250, 250, 250, 0.3); + } + &.sticky-on{ + position: fixed; + top: 0; + width: 100%; + z-index: 1020; + left: 0; + @include box-shadow(0px 0px 10px rgba(0, 0, 0, 0.05)); + -webkit-animation: slide-down 0.7s; + -moz-animation: slide-down 0.7s; + animation: slide-down 0.7s; + @-webkit-keyframes slide-down { 0% { opacity:0; transform:translateY(-100%);}100% { opacity:1; transform:translateY(0);}} + @-moz-keyframes slide-down { 0% { opacity:0; transform:translateY(-100%);}100% { opacity:1; transform:translateY(0);}} + @keyframes slide-down { 0% { opacity:0; transform:translateY(-100%);}100% { opacity:1; transform:translateY(0);}} + + .none-on-sticky{ + display:none!important; + } + } + + ul.navbar-nav > li { + display: -webkit-box; + display: -ms-flexbox; + display: flex; + height: 100%; + + + li { + margin-left: 2px; + } + a { + display: -webkit-box; + display: -ms-flexbox; + display: flex; + -webkit-box-align: center; + -ms-flex-align: center; + align-items: center; + } + + > a:not(.btn) { + height: 70px; + padding:0px 0.85em; + color: #252b33; + @include transition(all .2s ease); + position: relative; + position:relative; + } + + &:hover > a:not(.btn), & > a.active:not(.btn) { + color: $primary-color; + text-decoration:none; + @include transition(all .2s ease); + } + a.btn{padding: 0.4rem 1.4rem;} + &.dropdown { + .dropdown-menu li { + > a:not(.btn) { + padding: 8px 0px; + background-color: transparent; + text-transform: none; + color: #777; + @include transition(all .2s ease); + } + &:hover > a:not(.btn) { + color: $primary-color; + @include transition(all .2s ease); + } + } + &:hover > a:after { + clear: both; + content: ' '; + display: block; + width: 0; + height: 0; + border-style: solid; + border-color: transparent transparent #fff transparent; + position: absolute; + border-width: 0px 7px 6px 7px; + bottom: 0px; + left: 50%; + margin: 0 0 0 -5px; + z-index: 1022; + } + .dropdown-menu { + @include box-shadow(0px 0px 12px rgba(0, 0, 0, 0.176)); + border: 0px none; + padding: 10px 15px; + min-width: 220px; + margin: 0; + font-size: 14px; + font-size: 0.875rem; + z-index:1021; + } + > .dropdown-toggle .arrow { + display: none; + + } + } + } + .dropdown-menu-right { + left: auto !important; + right: 100% !important; + } + ul.navbar-nav > li { + &.dropdown-mega { + position: static; + > .dropdown-menu { + width: 100%; + padding: 20px 20px; + margin-left: 0px !important; + } + .dropdown-mega-content > .row > div { + padding: 5px 5px 5px 20px; + border-right: 1px solid #eee; + &:last-child { + border-right: 0; + } + } + .sub-title { + display: block; + font-size: 16px; + margin-top: 1rem; + padding-bottom: 5px; + } + .dropdown-mega-submenu { + list-style-type: none; + padding-left: 0px; + } + } + a.btn{font-size:14px; padding: 0.65rem 2rem; text-transform:uppercase;} + &.dropdown { + .dropdown-menu { + .dropdown-menu { + left: 100%; + margin-top: -40px; + } + .dropdown-toggle:after { + border-top: .4em solid transparent; + border-right: 0; + border-bottom: 0.4em solid transparent; + border-left: 0.4em solid; + } + } + .dropdown-toggle .arrow { + position: absolute; + min-width: 30px; + height: 100%; + right: 0px; + top: 0; + @include transition(all .2s ease); + &:after { + content: " "; + position: absolute; + top: 50%; + left: 50%; + border-color: #000; + border-top: 1px solid; + border-right: 1px solid; + width: 6px; + height: 6px; + -webkit-transform: translate(-50%, -50%) rotate(45deg); + transform: translate(-50%, -50%) rotate(45deg); + } + } + } + } + .dropdown-toggle:after { + content: none; + } + + &.navbar-line-under-text ul.navbar-nav > li { + > a:not(.btn):after { + position: absolute; + content: ""; + height: 2px; + width: 0; + left: 50%; + right: 0; + bottom: 14px; + background-color: transparent; + color:#fff; + border-bottom: 2px solid $primary-color; + @include transition(all .3s ease-in-out); + transform: translate(-50%,0) translateZ(0); + -webkit-transform: translate(-50%,0) translateZ(0); + } + & > a:hover:not(.logo):after, & > a.active:after{ + width:calc(100% - 0.99em); + } + } + +} + +/*== Color Options ==*/ + +.primary-menu.navbar-text-light .navbar-toggler span {background:#fff;} + +.primary-menu.navbar-text-light .navbar-nav > li{ + > a:not(.btn) { + color: #fff; + } + &:hover > a:not(.btn), & > a.active:not(.btn) { + color: rgba(250, 250, 250, 0.75); + } +} + +.primary-menu.navbar-text-light.navbar-line-under-text .navbar-nav > li{ + & > a:not(.logo):after, & > a.active:after{ + border-color:rgba(250, 250, 250, 0.60); + } +} + +.primary-menu { + &.navbar-dropdown-dark ul.navbar-nav > li { + &.dropdown { + .dropdown-menu { + background-color: #252A2C; + color: #fff; + .dropdown-menu { + background-color: #272c2e; + } + } + &:hover > a:after { + border-color: transparent transparent #252A2C transparent; + } + .dropdown-menu li { + > a:not(.btn) { + color: rgba(250, 250, 250, 0.8); + } + &:hover > a:not(.btn) { + color: rgba(250, 250, 250, 1); + font-weight:600; + } + } + } + &.dropdown-mega .dropdown-mega-content > .row > div { + border-color: #3a3a3a; + } + } + &.navbar-dropdown-primary ul.navbar-nav > li { + &.dropdown { + .dropdown-menu { + background-color: $primary-color; + color: #fff; + .dropdown-menu { + background-color: $primary-color; + } + } + &:hover > a:after { + border-color: transparent transparent $primary-color transparent; + } + .dropdown-menu li { + > a:not(.btn) { + color: rgba(250, 250, 250, 0.95); + } + &:hover > a:not(.btn) { + color: rgba(250, 250, 250, 1); + font-weight:600; + } + } + } + &.dropdown-mega .dropdown-mega-content > .row > div { + border-color: rgba(250, 250, 250, 0.2); + } + } +} + + +/* Hamburger Menu Button */ +.navbar-toggler { + width: 25px; + height: 30px; + padding: 10px; + margin: 18px 15px; + position: relative; + border:none; + @include rotate(0deg); + @include transition(.5s ease-in-out); + cursor: pointer; + display: block; + span { + display: block; + position: absolute; + height: 2px; + width: 100%; + background: #3c3636; + border-radius: 2px; + opacity: 1; + left: 0; + @include rotate(0deg); + @include transition(.25s ease-in-out); + &:nth-child(1) { + top: 7px; + -webkit-transform-origin: left center; + -moz-transform-origin: left center; + -o-transform-origin: left center; + transform-origin: left center; + } + &:nth-child(2) { + top: 14px; + -webkit-transform-origin: left center; + -moz-transform-origin: left center; + -o-transform-origin: left center; + transform-origin: left center; + } + &:nth-child(3) { + top: 21px; + -webkit-transform-origin: left center; + -moz-transform-origin: left center; + -o-transform-origin: left center; + transform-origin: left center; + + } + } + &.show span { + &:nth-child(1) { + top: 4px; + left: 3px; + @include rotate(45deg); + } + &:nth-child(2) { + width: 0%; + opacity: 0; + } + &:nth-child(3) { + top: 22px; + left: 3px; + @include rotate(-45deg); + } + } + +} + +.navbar-accordion{position:initial;} + + +// For Responsive Navbar +@mixin navbar-responsive { + +.navbar-collapse { + position: absolute; + top: 99%; + right: 0; + left: 0; + background: #fff; + margin-top: 0px; + z-index: 1000; + @include box-shadow(0px 0px 15px rgba(0, 0, 0, 0.1)); + .navbar-nav { + overflow: hidden; + overflow-y: auto; + max-height: 65vh; + padding: 15px; + } +} +ul.navbar-nav { + li { + display: block; + border-bottom: 1px solid #eee; + margin: 0; + padding: 0; + &:last-child { + border: none; + } + + li { + margin-left: 0px; + } + &.dropdown > .dropdown-toggle > .arrow.show:after { + -webkit-transform: translate(-50%, -50%) rotate(-45deg); + transform: translate(-50%, -50%) rotate(-45deg); + @include transition(all .2s ease); + } + > a:hover:after, > a.active:after { + content: none!important; + width:0px!important; + } + &.dropdown{ + > .dropdown-toggle .arrow { + display: block; + + } + } + } + + > li { + > a:not(.btn) { + height: auto; + padding: 8px 0; + position: relative; + } + &.dropdown { + .dropdown-menu li > a:not(.btn) { + padding: 8px 0; + position: relative; + } + &:hover > a:after { + content: none; + } + .dropdown-toggle .arrow:after { + -webkit-transform: translate(-50%, -50%) rotate(134deg); + transform: translate(-50%, -50%) rotate(134deg); + @include transition(all .2s ease); + } + } + } + > li { + &.dropdown .dropdown-menu { + margin: 0; + @include box-shadow(none); + border: none; + padding: 0px 0px 0px 15px; + .dropdown-menu { + margin: 0; + } + } + &.dropdown-mega { + .dropdown-mega-content > .row > div { + padding: 0px 15px; + } + } + } + +} + +&.navbar-text-light .navbar-collapse{background:rgba(0,0,0,0.95);} + +&.navbar-text-light .navbar-collapse ul.navbar-nav li{ + border-color:rgba(250,250,250,0.15); +} + + +&.navbar-dropdown-dark .navbar-collapse { + background-color: #252A2C; +} + +&.navbar-dropdown-primary .navbar-collapse { + background-color: $primary-color; +} + + &.navbar-dropdown-primary ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + background-color: $primary-color; + } + &.navbar-dropdown-dark ul.navbar-nav { + li { + border-color: #444; + } + > li { + > a { + color: #a3a2a2; + } + &:hover > a { + color: #fff; + } + } + } + &.navbar-dropdown-primary ul.navbar-nav { + li { + border-color: rgba(250, 250, 250, 0.2); + } + > li { + > a { + color: rgba(250, 250, 250, 0.8); + } + &:hover > a { + color: #fff; + } + } + } + +} + +.navbar-expand-none{ + @include navbar-responsive; +} + + +@include media-breakpoint-down(xs) { + .navbar-expand-sm{ + @include navbar-responsive; + } +} + +@include media-breakpoint-down(sm) { + .navbar-expand-md{ + @include navbar-responsive; + } +} + +@include media-breakpoint-down(md) { + .navbar-expand-lg{ + @include navbar-responsive; + } +} +@include media-breakpoint-down(lg) { + .navbar-expand-xl{ + @include navbar-responsive; + } +} \ No newline at end of file diff --git a/docs/assets/sass/_helpers.scss b/docs/assets/sass/_helpers.scss new file mode 100644 index 00000000..6845d7bc --- /dev/null +++ b/docs/assets/sass/_helpers.scss @@ -0,0 +1,301 @@ +/* =================================== */ +/* 2. Helpers Classes +/* =================================== */ + +/* Box Shadow */ +.shadow-md { + @include box-shadow(0px 0px 50px -35px rgba(0, 0, 0, 0.4)!important); +} + +/* Border Radius */ + +.rounded-lg{ + border-radius: 0.6rem !important; +} + +.rounded-top-0{ + border-top-left-radius:0px!important; + border-top-right-radius:0px!important; +} +.rounded-bottom-0{ + border-bottom-left-radius:0px!important; + border-bottom-right-radius:0px!important; +} +.rounded-left-0{ + border-top-left-radius:0px!important; + border-bottom-left-radius:0px!important; +} +.rounded-right-0{border-top-right-radius:0px!important; + border-bottom-right-radius:0px!important; +} + + +/* Border Size */ + +.border-1{ + border-width:1px!important; +} +.border-2{ + border-width:2px!important; +} +.border-3{ + border-width:3px!important; +} +.border-4{ + border-width:4px!important; +} +.border-5{ + border-width:5px!important; +} + +/* Text Size */ +.text-0 { + font-size: 11px !important; + font-size: 0.6875rem !important; +} +.text-1 { + font-size: 12px !important; + font-size: 0.75rem !important; +} +.text-2 { + font-size: 14px !important; + font-size: 0.875rem !important; +} +.text-3 { + font-size: 16px !important; + font-size: 1rem !important; +} +.text-4 { + font-size: 18px !important; + font-size: 1.125rem !important; +} +.text-5 { + font-size: 21px !important; + font-size: 1.3125rem !important; +} +.text-6 { + font-size: 24px !important; + font-size: 1.50rem !important; +} +.text-7 { + font-size: 28px !important; + font-size: 1.75rem !important; +} +.text-8 { + font-size: 32px !important; + font-size: 2rem !important; +} +.text-9 { + font-size: 36px !important; + font-size: 2.25rem !important; +} +.text-10 { + font-size: 40px !important; + font-size: 2.50rem !important; +} +.text-11 { + @include rfs(44, true); +} +.text-12 { + @include rfs(48, true); +} +.text-13 { + @include rfs(52, true); +} +.text-14 { + @include rfs(56, true); +} +.text-15 { + @include rfs(60, true); +} +.text-16 { + @include rfs(64, true); +} +.text-17 { + @include rfs(72, true); +} +.text-18 { + @include rfs(80, true); +} +.text-19 { + @include rfs(84, true); +} +.text-20 { + @include rfs(92, true); +} +.text-21 { + @include rfs(104, true); +} +.text-22 { + @include rfs(112, true); +} +.text-23 { + @include rfs(124, true); +} +.text-24 { + @include rfs(132, true); +} +.text-25 { + @include rfs(144, true); +} + +.text-11, .text-12, .text-13, .text-14, .text-15, .text-16, .text-17, .text-18, .text-19, .text-20, .text-21, .text-22, .text-23, .text-24, .text-25{ + line-height: 1.3; +} + + +/* Line height */ +.line-height-07 { + line-height: 0.7 !important; +} + +.line-height-1 { + line-height: 1 !important; +} + +.line-height-2 { + line-height: 1.2 !important; +} + +.line-height-3 { + line-height: 1.4 !important; +} + +.line-height-4 { + line-height: 1.6 !important; +} + +.line-height-5 { + line-height: 1.8 !important; +} + +/* Font Weight */ +.font-weight-100 { + font-weight: 100 !important; +} + +.font-weight-200 { + font-weight: 200 !important; +} + +.font-weight-300 { + font-weight: 300 !important; +} + +.font-weight-400 { + font-weight: 400 !important; +} +.font-weight-500 { + font-weight: 500 !important; +} + +.font-weight-600 { + font-weight: 600 !important; +} +.font-weight-700 { + font-weight: 700 !important; +} +.font-weight-800 { + font-weight: 800 !important; +} +.font-weight-900 { + font-weight: 900 !important; +} + +/* Opacity */ +.opacity-0 { + opacity: 0; +} + +.opacity-1 { + opacity: 0.1; +} + +.opacity-2 { + opacity: 0.2; +} + +.opacity-3 { + opacity: 0.3; +} + +.opacity-4 { + opacity: 0.4; +} + +.opacity-5 { + opacity: 0.5; +} + +.opacity-6 { + opacity: 0.6; +} + +.opacity-7 { + opacity: 0.7; +} + +.opacity-8 { + opacity: 0.8; +} + +.opacity-9 { + opacity: 0.9; +} + +.opacity-10 { + opacity: 1; +} + +/* Background light */ +.bg-light-1 { + background-color: $gray-200 !important; +} + +.bg-light-2 { + background-color: $gray-300 !important; +} + +.bg-light-3 { + background-color: $gray-400 !important; +} + +.bg-light-4 { + background-color: $gray-500 !important; +} + + +/* Background Dark */ +.bg-dark { + background-color: #111418 !important; +} + +.bg-dark-1 { + background-color: $gray-900 !important; +} + +.bg-dark-2 { + background-color: $gray-800 !important; +} + +.bg-dark-3 { + background-color: $gray-700 !important; +} + +.bg-dark-4 { + background-color: $gray-600 !important; +} + + +/* Progress Bar */ +.progress-sm { + height: 0.5rem !important; +} + +.progress-lg { + height: 1.5rem !important; +} + +hr{ + border-top:1px solid rgba(16,85,96,.1); +} \ No newline at end of file diff --git a/docs/assets/sass/_layouts.scss b/docs/assets/sass/_layouts.scss new file mode 100644 index 00000000..2ec1e1a5 --- /dev/null +++ b/docs/assets/sass/_layouts.scss @@ -0,0 +1,171 @@ +/* =================================== */ +/* 3. Layouts +/* =================================== */ + +#main-wrapper { + background:#fff; +} + +.box { + #main-wrapper { + max-width: 1200px; + margin: 0 auto; + @include box-shadow(0px 0px 10px rgba(0, 0, 0, 0.1)); + } + .idocs-navigation { + left: auto; + } +} + + +@include media-breakpoint-up(xl) { + .container { + max-width: 1170px !important; + } +} + + +/*=== 3.1 Side Navigation ===*/ + +.idocs-navigation { + position: fixed; + top: 70px; + left: 0; + overflow: hidden; + overflow-y: auto; + width: 260px; + height: calc(100% - 70px); + z-index: 1; + border-right: 1px solid rgba(0, 0, 0, 0.05); + transition: all 0.3s; + > .nav { + padding: 30px 0; + } + .nav { + .nav-item { + position: relative; + } + .nav { + margin: 0 0 5px; + } + .nav-link { + position: relative; + padding: 6px 30px; + line-height: 25px; + font-weight: 600; + } + .nav-item { + &:hover > .nav-link, .nav-link.active { + font-weight: 700; + } + } + .nav { + .nav-item .nav-link { + &:after { + content: ""; + position: absolute; + left: 30px; + height: 100%; + border-left: 1px solid rgba(0, 0, 0, 0.12); + width: 1px; + top: 0; + } + &.active:after { + border-color: $primary-color; + border-width: 2px; + } + } + display: none; + border-left: 1px solid regba(0, 0, 0, 0.3); + } + .nav-item .nav-link.active + .nav { + display: block; + } + .nav { + .nav-link { + color: #6a6a6a; + padding: 4px 30px 4px 45px; + font-size: 15px; + text-transform: none; + } + .nav { + .nav-link { + padding: 4px 30px 4px 60px; + font-size: 15px; + } + .nav-item .nav-link:after { + left: 45px; + } + } + } + } + > .nav > .nav-item > .nav-link.active:after { + position: absolute; + content: " "; + top: 50%; + right: 18px; + border-color: #000; + border-top: 2px solid; + border-right: 2px solid; + width: 7px; + height: 7px; + -webkit-transform: translate(-50%, -50%) rotate(45deg); + transform: translate(-50%, -50%) rotate(45deg); + @include transition(all .2s ease); + } + &.docs-navigation-dark .nav { + .nav-link { + color: rgba(250, 250, 250, 0.85); + } + .nav { + .nav-link { + color: rgba(250, 250, 250, 0.7); + } + .nav-item .nav-link { + &:after { + border-color: rgba(250, 250, 250, 0.2); + } + &.active:after { + border-color: $primary-color; + } + } + } + } +} + +/*=== 3.2 Docs Content ===*/ + +.idocs-content { + position: relative; + margin-left: 260px; + padding: 0px 50px 50px; + min-height: 750px; + transition: all 0.3s; + + section:first-child { + padding-top: 3rem; + } + ol li, ul li { + margin-top: 10px; + } + +} + + +@include media-breakpoint-down(sm) { +.idocs-navigation { + margin-left: -260px; + + &.active { + margin-left: 0; + } +} +.idocs-content { + margin-left:0px; + padding:0px; +} +} + +/*=== 3.3 Section Divider ===*/ + +.divider{margin: 4rem 0;} diff --git a/docs/assets/sass/_mixins.scss b/docs/assets/sass/_mixins.scss new file mode 100644 index 00000000..a49c550b --- /dev/null +++ b/docs/assets/sass/_mixins.scss @@ -0,0 +1,31 @@ +//---------- @mixins ----------// + +@mixin box-shadow($val...) { + -webkit-box-shadow: ($val); + box-shadow: ($val); +} + +@mixin transition($val...) { + -webkit-transition: ($val); + transition: ($val); +} + +@mixin translateY($val...) { + -webkit-transform: translateY($val); + transform: translateY($val); +} + +@mixin translateX($val...) { + -webkit-transform: translateX($val); + transform: translateX($val); +} + +@mixin rotate($val){ + -webkit-transform: rotate($val); + transform: rotate($val); +} + +@mixin scale($val){ + -webkit-transform: scale($val); + transform: scale($val); +} \ No newline at end of file diff --git a/docs/assets/sass/_reset.scss b/docs/assets/sass/_reset.scss new file mode 100644 index 00000000..727986c6 --- /dev/null +++ b/docs/assets/sass/_reset.scss @@ -0,0 +1,164 @@ +/* =================================== */ +/* 1. Basic Style +/* =================================== */ + +body, html { +height:100%; +} + +body { + background: $body-bg; + color: $text-color; +} + +/*-------- Preloader --------*/ +.preloader { + position: fixed; + width: 100%; + height: 100%; + z-index: 999999999 !important; + background-color: #fff; + top: 0; + left: 0; + right: 0; + bottom: 0; + .lds-ellipsis { + display: inline-block; + position: absolute; + width: 80px; + height: 80px; + margin-top: -40px; + margin-left: -40px; + top: 50%; + left: 50%; + div { + position: absolute; + top: 33px; + width: 13px; + height: 13px; + border-radius: 50%; + background: #000; + animation-timing-function: cubic-bezier(0, 1, 1, 0); + &:nth-child(1) { + left: 8px; + animation: lds-ellipsis1 0.6s infinite; + } + &:nth-child(2) { + left: 8px; + animation: lds-ellipsis2 0.6s infinite; + } + &:nth-child(3) { + left: 32px; + animation: lds-ellipsis2 0.6s infinite; + } + &:nth-child(4) { + left: 56px; + animation: lds-ellipsis3 0.6s infinite; + } + } + } +} + +@keyframes lds-ellipsis1 { + 0% { + transform: scale(0); + } + 100% { + transform: scale(1); + } +} + +@keyframes lds-ellipsis3 { + 0% { + transform: scale(1); + } + + 100% { + transform: scale(0); + } +} + +@keyframes lds-ellipsis2 { + 0% { + transform: translate(0, 0); + } + 100% { + transform: translate(24px, 0); + } +} + +/*--- Preloader Magnific Popup ----*/ +.mfp-container .preloader{ + background: transparent; + .lds-ellipsis div{ + background: #fff; + } +} + +::selection { + background: $primary-color; + color: #fff; + text-shadow: none; +} + +code{padding: 2px 5px; background-color: #f9f2f4; border-radius: 4px;} + +form { + padding: 0; + margin: 0; + display: inline; +} + +img { + vertical-align: inherit; +} +a, a:focus { + color: $primary-color; + @include transition(all .2s ease); +} +a:hover, a:active { + color: $primary-color-hover; + + @include transition(all .2s ease); +} + +a:focus, a:active, +.btn.active.focus, +.btn.active:focus, +.btn.focus, +.btn:active.focus, +.btn:active:focus, +.btn:focus, +button:focus, +button:active{ + outline: none; +} + +p { + line-height: 1.8; +} + +blockquote { + border-left: 5px solid #eee; + padding: 10px 20px; +} + +iframe { + border: 0 !important; +} + +h1, h2, h3, h4, h5, h6 { + color: $title-color; + line-height: 1.5; + margin: 0 0 1.5rem 0; + font-family:Roboto, sans-serif; +} + +h1{font-size:3rem;} + +h2{font-size:2.2rem;} + +dl, ol, ul, pre, blockquote, .table{margin-bottom:1.8rem;} + +/*=== Highlight Js ===*/ +.hljs {padding: 1.5rem;} \ No newline at end of file diff --git a/docs/assets/sass/_variables.scss b/docs/assets/sass/_variables.scss new file mode 100644 index 00000000..d2504f9c --- /dev/null +++ b/docs/assets/sass/_variables.scss @@ -0,0 +1,44 @@ +/*=========================================================== + + Template Name: iDocs - One Page Documentation HTML Template + Author: Harnish Design + Template URL: http://demo.harnishdesign.net/html/idocs + Author URL: https://themeforest.net/user/harnishdesign + File Description : Main css file of the template + +================================================= + Table of Contents +================================================= + + 1. Basic + 2. Helpers Classes + 3. Layouts + 3.1 Side Navigation + 3.2 Docs Content + 3.3 Section Divider + 4. Header + 4.1 Main Navigation + 5 Elements + 5.1 List Style + 5.2 Changelog + 5.3 Accordion & Toggle + 5.4 Nav + 5.5 Tabs + 5.6 Popup Img + 5.7 Featured Box + 6 Footer + 6.1 Social Icons + 6.2 Back to Top + 7 Extra + +=======================================================*/ + +//-------------------- Base Colors --------------------// + +$primary-color: #0366d6; +$primary-color-hover: darken($primary-color, 7%); +$secondary-color: $secondary; + +$body-bg: #dddddd; +$text-color: #4c4d4d; +$title-color: #252b33; \ No newline at end of file diff --git a/docs/assets/sass/bootstrap/_alert.scss b/docs/assets/sass/bootstrap/_alert.scss new file mode 100644 index 00000000..da2a98af --- /dev/null +++ b/docs/assets/sass/bootstrap/_alert.scss @@ -0,0 +1,51 @@ +// +// Base styles +// + +.alert { + position: relative; + padding: $alert-padding-y $alert-padding-x; + margin-bottom: $alert-margin-bottom; + border: $alert-border-width solid transparent; + @include border-radius($alert-border-radius); +} + +// Headings for larger alerts +.alert-heading { + // Specified to prevent conflicts of changing $headings-color + color: inherit; +} + +// Provide class for links that match alerts +.alert-link { + font-weight: $alert-link-font-weight; +} + + +// Dismissible alerts +// +// Expand the right padding and account for the close button's positioning. + +.alert-dismissible { + padding-right: $close-font-size + $alert-padding-x * 2; + + // Adjust close link position + .close { + position: absolute; + top: 0; + right: 0; + padding: $alert-padding-y $alert-padding-x; + color: inherit; + } +} + + +// Alternate styles +// +// Generate contextual modifier classes for colorizing the alert. + +@each $color, $value in $theme-colors { + .alert-#{$color} { + @include alert-variant(theme-color-level($color, $alert-bg-level), theme-color-level($color, $alert-border-level), theme-color-level($color, $alert-color-level)); + } +} diff --git a/docs/assets/sass/bootstrap/_badge.scss b/docs/assets/sass/bootstrap/_badge.scss new file mode 100644 index 00000000..42c5d08d --- /dev/null +++ b/docs/assets/sass/bootstrap/_badge.scss @@ -0,0 +1,54 @@ +// Base class +// +// Requires one of the contextual, color modifier classes for `color` and +// `background-color`. + +.badge { + display: inline-block; + padding: $badge-padding-y $badge-padding-x; + @include font-size($badge-font-size); + font-weight: $badge-font-weight; + line-height: 1; + text-align: center; + white-space: nowrap; + vertical-align: baseline; + @include border-radius($badge-border-radius); + @include transition($badge-transition); + + @at-root a#{&} { + @include hover-focus() { + text-decoration: none; + } + } + + // Empty badges collapse automatically + &:empty { + display: none; + } +} + +// Quick fix for badges in buttons +.btn .badge { + position: relative; + top: -1px; +} + +// Pill badges +// +// Make them extra rounded with a modifier to replace v3's badges. + +.badge-pill { + padding-right: $badge-pill-padding-x; + padding-left: $badge-pill-padding-x; + @include border-radius($badge-pill-border-radius); +} + +// Colors +// +// Contextual variations (linked badges get darker on :hover). + +@each $color, $value in $theme-colors { + .badge-#{$color} { + @include badge-variant($value); + } +} diff --git a/docs/assets/sass/bootstrap/_breadcrumb.scss b/docs/assets/sass/bootstrap/_breadcrumb.scss new file mode 100644 index 00000000..a0cf7e29 --- /dev/null +++ b/docs/assets/sass/bootstrap/_breadcrumb.scss @@ -0,0 +1,44 @@ +.breadcrumb { + display: flex; + flex-wrap: wrap; + padding: $breadcrumb-padding-y $breadcrumb-padding-x; + margin-bottom: $breadcrumb-margin-bottom; + @include font-size($breadcrumb-font-size); + list-style: none; + background-color: $breadcrumb-bg; + @include border-radius($breadcrumb-border-radius); +} + +.breadcrumb-item { + display: flex; + + // The separator between breadcrumbs (by default, a forward-slash: "/") + + .breadcrumb-item { + padding-left: $breadcrumb-item-padding; + + &::before { + display: inline-block; // Suppress underlining of the separator in modern browsers + padding-right: $breadcrumb-item-padding; + color: $breadcrumb-divider-color; + content: escape-svg($breadcrumb-divider); + } + } + + // IE9-11 hack to properly handle hyperlink underlines for breadcrumbs built + // without `