Syntax

exchange.GetDepth

Gets the Depth structure, i.e. the order book data, of the spot or contract corresponding to the currently set trading pair and contract code.


    
    
    
exchange.GetDepth()


    
    
    
exchange.GetDepth(symbol)

Examples

Get the depth of the current trading pair and print the second ask price.


    javascript
    
    
function main(){
    var depth = exchange.GetDepth()
    if (!depth || depth.Asks.length < 2) return    // null on failure
    var price = depth.Asks[1].Price
    Log("Second ask price", price)
}


    python
    
    
def main():
    depth = exchange.GetDepth()
    if not depth or len(depth["Asks"]) < 2:
        return
    price = depth["Asks"][1]["Price"]
    Log("Second ask price", price)


    rust
    
    
fn main() {
    let Ok(depth) = exchange.GetDepth(None) else { return };
    if depth.Asks.len() < 2 {
        return;
    }
    let price = depth.Asks[1].Price;
    Log!("Second ask price", price);
}

When the configured exchange object is a futures exchange object, use the symbol parameter to request the order book data of a specified instrument (futures instrument).


    javascript
    
    
function main() {
    // BTC USDT-margined perpetual contract
    var depth = exchange.GetDepth("BTC_USDT.swap")
    Log(depth)
}


    python
    
    
def main():
    depth = exchange.GetDepth("BTC_USDT.swap")
    Log(depth)


    rust
    
    
fn main() {
    // BTC USDT-margined perpetual contract
    let depth = exchange.GetDepth("BTC_USDT.swap").unwrap();
    Log!(depth);
}

Returns

Type	Description
`Depth` / null value	`Depth` structure on success; null value on failure.

Arguments

Name	Type	Required	Description
symbol	string	No	Instrument code, for example `BTC_USDT` on a spot exchange object or `BTC_USDT.swap` on a futures exchange object; the notation (including options) is described in `Symbols`. If omitted, the order book of the current trading pair and contract code is requested.