Syntax

HttpQuery

Send HTTP request.


    
    
    
HttpQuery(url)


    
    
    
HttpQuery(url, options)

Examples

Example of accessing OKX public market API endpoints.


    javascript
    
    
function main(){
    // 一个不带参数的GET请求示例
    var info = JSON.parse(HttpQuery("https://www.okx.com/api/v5/public/time"))
    Log(info)
    // 一个带参数的GET请求示例
    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不支持Python，可以使用urllib/urllib2库替代
    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)


    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);
}

Example of using proxy settings with HttpQuery function.


    javascript
    
    
function main() {
    // 本次设置代理并发送HTTP请求，无用户名、无密码，此次HTTP请求将通过代理发送
    HttpQuery("socks5://127.0.0.1:8889/http://www.baidu.com/")

    // 本次设置代理并发送HTTP请求，包含用户名和密码，仅对当前HttpQuery调用生效，后续调用HttpQuery("http://www.baidu.com")将不会使用代理
    HttpQuery("socks5://username:[email protected]:8889/http://www.baidu.com/")
}


    python
    
    
# HttpQuery不支持Python，可以使用Python的urllib2库


    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` language strategies, and the `json::parse()` function in `C++` language strategies. If `debug` is set to true in the `options` structure parameter, 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

URL address for the HTTP request.

options

object

HTTP request configuration parameters, can use 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: Set the request method.
body: Set the request body content, typically used for POST, PUT requests.
cookie: Set the Cookie in the request, generally used to carry authentication information or session identifiers.
headers: Set request header information, can be used to specify content type, authentication information, etc.
debug: When set to true, this HttpQuery function call returns the complete response message; when set to false, only returns the data in the response message Body.
timeout: Timeout setting in milliseconds, setting 1000 means 1 second timeout.
charset: Supports transcoding of request response data, for example: GB18030. Supports common encoding formats.

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