Syntax


    javascript
    
    
function main(){
    // An example of a GET request without parameters
    var info = JSON.parse(HttpQuery("https://www.okx.com/api/v5/public/time"))
    Log(info)
    // An example of a GET request with parameters
    var ticker = JSON.parse(HttpQuery("https://www.okx.com/api/v5/market/books?instId=BTC-USDT"))
    Log(ticker)
}


    python
    
    
import json
import urllib.request
def main():
    # HttpQuery does not support Python; you can use the urllib/urllib2 library instead
    info = json.loads(urllib.request.urlopen("https://www.okx.com/api/v5/public/time").read().decode('utf-8'))
    Log(info)
    ticker = json.loads(urllib.request.urlopen("https://www.okx.com/api/v5/market/books?instId=BTC-USDT").read().decode('utf-8'))
    Log(ticker)


    rust
    
    
fn main() {
    // An example of a GET request without parameters; in Rust, the return value type annotation determines whether the Body string (String) or the complete response (HttpRet) is returned
    let body: String = HttpQuery("https://www.okx.com/api/v5/public/time", None);
    let info = JSONParse(&body).unwrap();
    Log!(info);
    // An example of a GET request with parameters
    let body2: String = HttpQuery("https://www.okx.com/api/v5/market/books?instId=BTC-USDT", None);
    let ticker = JSONParse(&body2).unwrap();
    Log!(ticker);
}


    c++
    
    
void main() {
    auto info = json::parse(HttpQuery("https://www.okx.com/api/v5/public/time"));
    Log(info);
    auto ticker = json::parse(HttpQuery("https://www.okx.com/api/v5/market/books?instId=BTC-USDT"));
    Log(ticker);
}

An example of using proxy settings with the HttpQuery function.


    javascript
    
    
function main() {
    // This sets a proxy and sends an HTTP request, with no username and no password; this HTTP request will be sent through the proxy
    HttpQuery("socks5://127.0.0.1:8889/http://www.baidu.com/")

    // This sets a proxy and sends an HTTP request, providing a username and password, effective only for the current call to HttpQuery; subsequent calls to HttpQuery("http://www.baidu.com") will not use the proxy
    HttpQuery("socks5://username:[email protected]:8889/http://www.baidu.com/")
}


    python
    
    
# HttpQuery does not support Python; you can use Python's urllib2 library


    rust
    
    
fn main() {
    // This sets a proxy and sends an HTTP request, with no username and no password; this HTTP request will be sent through the proxy
    let ret1: String = HttpQuery("socks5://127.0.0.1:8889/http://www.baidu.com/", None);

    // This sets a proxy and sends an HTTP request, providing a username and password, effective only for the current call to HttpQuery; subsequent calls to HttpQuery("http://www.baidu.com") will not use the proxy
    let ret2: String = HttpQuery("socks5://username:[email protected]:8889/http://www.baidu.com/", None);
}


    c++
    
    
void main() {
    HttpQuery("socks5://127.0.0.1:8889/http://www.baidu.com/");
    HttpQuery("socks5://username:[email protected]:8889/http://www.baidu.com/");
}

Returns

Type	Description
string / object	Returns the response data of the request. If the return value is a `JSON` string, it can be parsed using the `JSON.parse()` function in `JavaScript` strategies, and the `json::parse()` function in `C++` strategies. In the `options` parameter structure, if `debug` is set to true, the return value is an object (JSON); if `debug` is set to false, the return value is a string.

Arguments

Name Type Required Description

url

string

Yes

The URL of the HTTP request.

options

object

Settings related to the HTTP request, for example the following structure:


            json
            
            
{
    method: "POST",
    body: "a=10&b=20&c=30",
    charset: "UTF-8",
    cookie: "session_id=12345; lang=en",
    debug: false,
    headers: {"TEST-HTTP-QUERY": "123"},
    timeout: 1000
}

method: Used to set the request method.
body: Used to set the request body content, typically used for requests such as POST and PUT.
cookie: Used to set the Cookie in the request, typically used to carry authentication information or session identifiers.
headers: Used to set the request header information, which can be used to specify the content type, authentication information, etc.
debug: When set to true, this HttpQuery function call returns the complete response message; when set to false, it returns only the data in the response message Body.
timeout: Timeout setting; setting it to 1000 means the timeout is 1 second.
charset: Supports transcoding the response data of the request, for example: GB18030, supporting common encodings.

All fields in this structure are optional; for example, the headers field may be omitted.