Quick Start Guide

For developers eager to hit the ground running with the Cryptoracle Open API, here are a few quick steps to make your first call:

1. Obtain API access credentials Request the following key information via email ([e-mail]):

   • apiKey: A 32-character string serving as the API access identifier, to be used in the X-API-KEY field of the request header.

2. Call API test Use the code samples we provide to initiate a test request in your local environment. Please make sure to replace the placeholders in the sample with your own key information to verify whether the API responds correctly.

3. Integrate into your application After successfully completing the test, you can start building your application logic according to the detailed instructions in this API documentation. Familiarizing yourself with the functions and parameter structures of each API will help you use the service more efficiently.

4. Flexible combination of indicator calls According to business needs, freely combine different APIs or indicators to achieve customized data query and analysis functions.

Note: Currently, CORS configuration prohibits using JavaScript on the client side to make HTTP requests. Do not hardcode keys in client-side code; they must be stored through backend environment variables or key management services.

View Quick Start Code Examples

curl command line

curl -X POST "https://service.cryptoracle.network/openapi/v2.1/endpoint" \
  -H "X-API-KEY: 711457e5-ef55-44b6-badc-9c45981eefe8" \
  -H "Content-Type: application/json" \
  -d '{
    "endpoints": ["CO-A-02-01", "CO-A-02-02"],
    "startTime": "2025-05-01 00:00:00",
    "endTime": "2025-05-01 23:59:59",
    "timeType": "1d",
    "token": ["BTC", "ETH"]
  }'

Python

import json

# 依赖库
import requests

# ====================== 配置信息（请根据实际情况修改）=======================
API_URL = "https://service.cryptoracle.network/openapi/v2.1/endpoint"
# 平台提供的 API Key
API_KEY = "711457e5-ef55-44b6-badc-9c45981eefe8"

# ====================== 主流程 ======================

# 1. 构建请求体
request_body = {
    "apiKey": API_KEY,
    "endpoints": [
        "CO-A-02-01",
        "CO-A-02-02"
    ],
    "startTime": "2025-05-01 00:00:00",
    "endTime": "2025-05-02 00:00:00",
    "timeType": "1h",
    "token": [
        "BTC",
        "ETH"
    ]
}
# 2. 构建请求头
headers = {
    "Content-Type": "application/json",
    "X-API-KEY": API_KEY
}
try:
    # 3. 发起请求
    response = requests.post(API_URL, json=request_body, headers=headers)
    print("Status Code:", response.status_code)
    # 4. 解析响应
    if response.status_code == 200:
        res_json = response.json()
        if res_json.get("code") == 200:
            try:
                # 将字符串解析为 JSON 对象，并格式化输出
                formatted_data = json.dumps(json.loads(response.text), indent=2, ensure_ascii=False)
                print("返回数据Data:\n", formatted_data)
            except Exception as e:
                print("Error:", e)
        else:
            print("接口返回错误:", res_json.get("message"))
    else:
        print("请求失败，请检查网络或 URL 是否正确")
except Exception as e:
            print("Error:", e)

Java

import com.alibaba.fastjson.JSONObject;
import org.apache.http.HttpEntity;
import org.apache.http.HttpHeaders;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

import java.io.IOException;
import java.util.Arrays;

public class JavaExample {

    private static String apiKey = "711457e5-ef55-44b6-badc-9c45981eefe8";

    public static void main(String[] args) {
        String uri = "https://service.cryptoracle.network/openapi/v2.1/endpoint";

        // 构建JSON请求体
        JSONObject parameter = new JSONObject();
        parameter.put("endpoints", Arrays.asList("CO-A-02-01", "CO-A-02-02"));
        parameter.put("startTime", "2025-05-01 00:00:00");
        parameter.put("endTime", "2025-05-01 23:59:59");
        parameter.put("timeType", "1d");//15m 1h 4h 1d
        parameter.put("token",  Arrays.asList("BTC", "ETH"));

        System.out.println("request:"+parameter.toJSONString());
        try {
            String result = makePostAPICall(uri, parameter.toJSONString());
            System.out.println("response:"+result);
        } catch (IOException e) {
            System.out.println("Error: cannot access content - " + e.toString());
        }
    }

    public static String makePostAPICall(String uri, String parameter)
            throws IOException {
        String response_content = "";

        CloseableHttpClient client = HttpClients.createDefault();
        HttpPost request = new HttpPost(uri);

        // 设置请求头
        request.setHeader(HttpHeaders.CONTENT_TYPE, "application/json");
        request.setHeader(HttpHeaders.ACCEPT, "application/json");
        request.addHeader("X-API-KEY", apiKey);

        // 设置请求体
        StringEntity entity = new StringEntity(parameter, "UTF-8");
        request.setEntity(entity);

        CloseableHttpResponse response = client.execute(request);

        try {
            HttpEntity responseEntity = response.getEntity();
            if (responseEntity != null) {
                response_content = EntityUtils.toString(responseEntity);
                EntityUtils.consume(responseEntity);
            }
        } finally {
            response.close();
        }
        return response_content;
    }
}

Node.js

const axios = require('axios');

// 定义参数
const requestData = {
  "endpoints": [
    "CO-A-01-01",
    "CO-A-01-02"
  ],
  "startTime": "2025-05-01 00:00:00",
  "endTime": "2025-05-01 23:59:59",
  "timeType": "1d",
  "token": [
    "BTC",
    "ETH"
  ]
};

let response = null;
new Promise(async (resolve, reject) => {
  try {
    response = await axios.post('https://service.cryptoracle.network/openapi/v2.1/endpoint', 
      requestData,
      {
        headers: {
          'X-API-KEY': '711457e5-ef55-44b6-badc-9c45981eefe8',
          'Content-Type': 'application/json',
          'Accept': 'application/json'
        },
      }
    );
  } catch(ex) {
    response = null;
    console.log(ex);
    reject(ex);
  }
  if (response) {
    const json = response.data;
    console.log(json);
    resolve(json);
  }
});

PHP

<?php
/**
 * Requires curl enabled in php.ini
 **/

$url = 'https://service.cryptoracle.network/openapi/v2.1/endpoint';

// 构建请求参数
$data = [
    "endpoints" => [
        "CO-A-01-01",
        "CO-A-01-02"
    ],
    "startTime" => "2025-05-01 00:00:00",
    "endTime" => "2025-05-01 23:59:59",
    "timeType" => "1d",
    "token" => [
        "BTC",
        "ETH"
    ]
];

$headers = [
  'Accepts: application/json',
  'Content-Type: application/json',
  'X-API-KEY: 711457e5-ef55-44b6-badc-9c45981eefe8'
];

$curl = curl_init(); // Get cURL resource
// Set cURL options
curl_setopt_array($curl, array(
  CURLOPT_URL => $url,                // set the request URL
  CURLOPT_HTTPHEADER => $headers,     // set the headers 
  CURLOPT_RETURNTRANSFER => 1,        // ask for raw response instead of bool
  CURLOPT_POST => 1,                  // set method to POST
  CURLOPT_POSTFIELDS => json_encode($data) // add JSON data to POST request
));

$response = curl_exec($curl); // Send the request, save the response
print_r(json_decode($response)); // print json decoded response
curl_close($curl); // Close request
?>

Go

package main

import (
  "bytes"
  "fmt"
  "io/ioutil"
  "log"
  "net/http"
  "os"
)

func main() {
  client := &http.Client{}
  
  // 构建JSON请求体
  jsonStr := `{
    "endpoints": [
      "CO-A-01-01",
      "CO-A-01-02"
    ],
    "startTime": "2025-05-01 00:00:00",
    "endTime": "2025-05-01 23:59:59",
    "timeType": "1d",
    "token": [
      "BTC",
      "ETH"
    ]
  }`
  
  req, err := http.NewRequest("POST", "https://service.cryptoracle.network/openapi/v2.1/endpoint", bytes.NewBufferString(jsonStr))
  if err != nil {
    log.Print(err)
    os.Exit(1)
  }

  // 设置请求头
  req.Header.Set("Accept", "application/json")
  req.Header.Set("Content-Type", "application/json")
  req.Header.Add("X-API-KEY", "711457e5-ef55-44b6-badc-9c45981eefe8")

  resp, err := client.Do(req);
  if err != nil {
    fmt.Println("Error sending request to server")
    os.Exit(1)
  }
  fmt.Println(resp.Status);
  respBody, _ := ioutil.ReadAll(resp.Body)
  fmt.Println(string(respBody));
}

C#

using System;
using System.Net;
using System.Text;
using System.Web;

class CSharpExample
{
  private static string API_KEY = "711457e5-ef55-44b6-badc-9c45981eefe8";

  public static void Main(string[] args)
  {
    try
    {
      Console.WriteLine(makeAPICall());
    }
    catch (WebException e)
    {
      Console.WriteLine(e.Message);
    }
  }

  static string makeAPICall()
  {
    var URL = "https://service.cryptoracle.network/openapi/v2.1/endpoint";

    // 构建JSON请求体
    string jsonBody = @"{
      ""endpoints"": [
        ""CO-A-01-01"",
        ""CO-A-01-02""
      ],
      ""startTime"": ""2025-05-01 00:00:00"",
      ""endTime"": ""2025-05-01 23:59:59"",
      ""timeType"": ""1d"",
      ""token"": [
        ""BTC"",
        ""ETH""
      ]
    }";

    var client = new WebClient();
    client.Headers.Add("X-API-KEY", API_KEY);
    client.Headers.Add("Accepts", "application/json");
    client.Headers.Add("Content-Type", "application/json");
    
    // 发送POST请求
    return client.UploadString(URL, "POST", jsonBody);
  }
}

---