Struct crypto_rest_client::OkxRestClient
source · [−]pub struct OkxRestClient { /* private fields */ }
Expand description
The REST client for OKEx.
OKEx has Spot, Future, Swap and Option markets.
- API doc: https://www.okx.com/docs-v5/en/
- Trading at:
Implementations
sourceimpl OkxRestClient
impl OkxRestClient
pub fn new(api_key: Option<String>, api_secret: Option<String>) -> Self
sourcepub fn fetch_trades(symbol: &str) -> Result<String, Error>
pub fn fetch_trades(symbol: &str) -> Result<String, Error>
Get most recent trades.
500 trades are returned.
For example: https://www.okx.com/api/v5/market/trades?instId=BTC-USDT&limit=500
sourcepub fn fetch_l2_snapshot(symbol: &str) -> Result<String, Error>
pub fn fetch_l2_snapshot(symbol: &str) -> Result<String, Error>
Get the latest Level2 snapshot of orderbook.
Top 400 bids and asks are returned.
For example:
- https://www.okx.com/api/v5/market/books?instId=BTC-USDT&sz=400,
- https://www.okx.com/api/v5/market/books?instId=BTC-USDT-SWAP&sz=400
Rate limit: 20 requests per 2 seconds
sourcepub fn fetch_open_interest(
market_type: MarketType,
symbol: Option<&str>
) -> Result<String, Error>
pub fn fetch_open_interest(
market_type: MarketType,
symbol: Option<&str>
) -> Result<String, Error>
Get open interest.
inst_type: SWAP, FUTURES, OPTION
For example:
Auto Trait Implementations
impl RefUnwindSafe for OkxRestClient
impl Send for OkxRestClient
impl Sync for OkxRestClient
impl Unpin for OkxRestClient
impl UnwindSafe for OkxRestClient
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more