Enum Environment 

#[non_exhaustive]
pub enum Environment {
    Mainnet,
    MainnetBytick,
    Testnet,
    Demo,
    Turkey,
    Kazakhstan,
    Georgia,
    Indonesia,
    Custom {
        api: &'static str,
        stream: &'static str,
    },
}

A Bybit deployment: where to send REST requests and open WebSocket streams.

Region-specific sites have their own domains; use the variant of the site your account is registered on. Sites whose WebSocket domain Bybit does not document (UAE, EEA) or that did not resolve when this list was made (Japan, Hong Kong) are not listed: use Environment::Custom.

See https://bybit-exchange.github.io/docs/v5/guide and https://bybit-exchange.github.io/docs/v5/ws/connect.

use bybit::{Category, Environment};

let env = Environment::Demo;
assert_eq!(env.api_url(), "https://api-demo.bybit.com");
// Demo trading has private streams only; public data comes from mainnet.
assert_eq!(
    env.public_stream_url(Category::Linear),
    "wss://stream.bybit.com/v5/public/linear"
);
assert_eq!(env.private_stream_url(), "wss://stream-demo.bybit.com/v5/private");

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Mainnet

api.bybit.com, stream.bybit.com.

MainnetBytick

Alternative mainnet REST domain api.bytick.com (streams on stream.bybit.com).

Testnet

api-testnet.bybit.com, stream-testnet.bybit.com.

Demo

Demo trading: api-demo.bybit.com; private streams on stream-demo.bybit.com, public data from mainnet stream.bybit.com.

Turkey

Accounts registered on bybit.tr.

Kazakhstan

Accounts registered on bybit.kz.

Georgia

Accounts registered on bybitgeorgia.ge.

Indonesia

Accounts registered on bybit.id.

Custom

Any other deployment, e.g. api: "https://api.bybit.ae". Both values are base URLs without a trailing slash.

Fields

api: &'static str

REST base URL, e.g. https://api.bybit.com.

stream: &'static str

WebSocket base URL, e.g. wss://stream.bybit.com.

Implementations

impl Environment

pub fn api_url(&self) -> &'static str

REST base URL, e.g. https://api.bybit.com.

pub fn public_stream_url(&self, category: Category) -> String

URL of the public stream of category, e.g. wss://stream.bybit.com/v5/public/linear.

pub fn private_stream_url(&self) -> String

URL of the private stream (orders, positions, executions, wallet), e.g. wss://stream.bybit.com/v5/private.

pub fn trade_stream_url(&self) -> Option<String>

URL of the order entry stream (/v5/trade), or None where Bybit does not offer it: demo trading, and sites without a documented order entry stream (Georgia, Indonesia).

Trait Implementations

impl Clone for Environment

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Environment

impl Debug for Environment

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Environment

impl Hash for Environment

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Environment

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Environment