Skip to main content

Credentials

Struct Credentials 

Source
pub struct Credentials {
    pub api_key: String,
    pub api_secret: String,
}
Expand description

Gate.io API Credentials.

Communication with Gate.io API authenticated endpoints requires valid API credentials. These credentials are used for HMAC SHA-512 signing of requests to ensure authenticity.

Note: Production and testnet API credentials are not interchangeable. Make sure to use the appropriate credentials for your environment.

API Documentation

Fields§

§api_key: String

API key for authentication

§api_secret: String

API secret for HMAC signing

Implementations§

Source§

impl Credentials

Source

pub fn new(api_key: impl Into<String>, api_secret: impl Into<String>) -> Self

Creates new API credentials

Examples found in repository?
examples/sync/get_open_orders.rs (line 9)
4fn main() -> Result<(), Box<gateio_rs::ureq::Error>> {
5    dotenv::dotenv().ok();
6
7    let api_key = std::env::var("GATE_API_KEY").expect("GATE_API_KEY not set");
8    let api_secret = std::env::var("GATE_API_SECRET").expect("GATE_API_SECRET not set");
9    let credentials = Credentials::new(api_key, api_secret);
10
11    let client = GateHttpClient::default().credentials(credentials.clone());
12
13    let req = spot::get_open_orders().page(1).limit(100);
14
15    let resp = client.send(req)?;
16    let body = resp.into_body_str()?;
17    let resp_obj: Value = serde_json::from_str(&body).unwrap();
18    println!("{:?}", resp_obj);
19
20    Ok(())
21}
More examples
Hide additional examples
examples/sync/get_currencies.rs (line 9)
4fn main() -> Result<(), Box<gateio_rs::ureq::Error>> {
5    dotenv::dotenv().ok();
6
7    let api_key = std::env::var("GATE_API_KEY").expect("GATE_API_KEY not set");
8    let api_secret = std::env::var("GATE_API_SECRET").expect("GATE_API_SECRET not set");
9    let credentials = Credentials::new(api_key, api_secret);
10
11    let client = GateHttpClient::default().credentials(credentials.clone());
12
13    // Get all available currencies
14    let req = spot::get_currencies();
15
16    let resp = client.send(req)?;
17    let body = resp.into_body_str()?;
18    let resp_obj: Value = serde_json::from_str(&body).unwrap();
19    println!("{:?}", resp_obj);
20
21    Ok(())
22}
examples/sync/get_currency_pairs.rs (line 9)
4fn main() -> Result<(), Box<gateio_rs::ureq::Error>> {
5    dotenv::dotenv().ok();
6
7    let api_key = std::env::var("GATE_API_KEY").expect("GATE_API_KEY not set");
8    let api_secret = std::env::var("GATE_API_SECRET").expect("GATE_API_SECRET not set");
9    let credentials = Credentials::new(api_key, api_secret);
10
11    let client = GateHttpClient::default().credentials(credentials.clone());
12
13    // Get all available currency pairs
14    let req = spot::get_currency_pairs();
15
16    let resp = client.send(req)?;
17    let body = resp.into_body_str()?;
18    let resp_obj: Value = serde_json::from_str(&body).unwrap();
19    println!("{:?}", resp_obj);
20
21    Ok(())
22}
examples/sync/get_currency.rs (line 9)
4fn main() -> Result<(), Box<gateio_rs::ureq::Error>> {
5    dotenv::dotenv().ok();
6
7    let api_key = std::env::var("GATE_API_KEY").expect("GATE_API_KEY not set");
8    let api_secret = std::env::var("GATE_API_SECRET").expect("GATE_API_SECRET not set");
9    let credentials = Credentials::new(api_key, api_secret);
10
11    let client = GateHttpClient::default().credentials(credentials.clone());
12
13    // Get details for a specific currency
14    let req = spot::get_currency("BTC");
15
16    let resp = client.send(req)?;
17    let body = resp.into_body_str()?;
18    let resp_obj: Value = serde_json::from_str(&body).unwrap();
19    println!("{:?}", resp_obj);
20
21    Ok(())
22}
examples/sync/get_currency_pair.rs (line 9)
4fn main() -> Result<(), Box<gateio_rs::ureq::Error>> {
5    dotenv::dotenv().ok();
6
7    let api_key = std::env::var("GATE_API_KEY").expect("GATE_API_KEY not set");
8    let api_secret = std::env::var("GATE_API_SECRET").expect("GATE_API_SECRET not set");
9    let credentials = Credentials::new(api_key, api_secret);
10
11    let client = GateHttpClient::default().credentials(credentials.clone());
12
13    // Get details for a specific currency pair
14    let req = spot::get_currency_pair("BTC_USDT");
15
16    let resp = client.send(req)?;
17    let body = resp.into_body_str()?;
18    let resp_obj: Value = serde_json::from_str(&body).unwrap();
19    println!("{:?}", resp_obj);
20
21    Ok(())
22}
examples/sync/get_orderbook.rs (line 9)
4fn main() -> Result<(), Box<gateio_rs::ureq::Error>> {
5    dotenv::dotenv().ok();
6
7    let api_key = std::env::var("GATE_API_KEY").expect("GATE_API_KEY not set");
8    let api_secret = std::env::var("GATE_API_SECRET").expect("GATE_API_SECRET not set");
9    let credentials = Credentials::new(api_key, api_secret);
10
11    let client = GateHttpClient::default().credentials(credentials.clone());
12
13    // Get orderbook for BTC_USDT
14    let req = spot::get_orderbook("BTC_USDT").limit(100).interval("0");
15
16    let resp = client.send(req)?;
17    let body = resp.into_body_str()?;
18    let resp_obj: Value = serde_json::from_str(&body).unwrap();
19    println!("{:?}", resp_obj);
20
21    Ok(())
22}

Trait Implementations§

Source§

impl Clone for Credentials

Source§

fn clone(&self) -> Credentials

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Credentials

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Credentials

Source§

impl PartialEq for Credentials

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Credentials

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.