Carbon Emissions V2.0

Appsecurity: ${appsecurity}

With a vision of "living on time" , a global leading aviation data intelligence company

The VariFlight DataWorks Carbon Emissions API provides flight carbon-emissions data. Documented query methods use flight details, route and date, or aircraft registration and date; responses include flight identifiers, aircraft type and carbon emissions.

Appid: ${appid}

Create time: 2026-10-22

https://dataworks.variflight.com Email: dataworks@variflight.com

Introduction

This document describes the VariFlight Carbon Emissions V2.0 API, including authentication, request parameters, response fields, JSON examples and error responses. The interface uses UTF-8 encoding.

Authentication

The interface uses both token and IP for concurrent verification.

Token generation algorithm (MD5)

Registration code: Please obtain the registration code from the administrator of VariFlight. It is necessary for verification during the request process by both parties. Please be careful not to disclose it to the public.

Example (PHP):

<?php
function generateToken(array $data, string $appsecurity): string {
    unset($data['token']);
    ksort($data, SORT_STRING);
    $pairs = [];
    foreach ($data as $key => $value) {
        $pairs[] = $key . '=' . $value;
    }
    $str = implode('&', $pairs);
    return hash('md5', hash('md5', $str . $appsecurity));
}
// 参数值使用 UTF-8 原文;通过 token 参数传入结果,构建 URL 时再编码。
// $data['token'] = generateToken($data, $appsecurity);
// $query = http_build_query($data, '', '&', PHP_QUERY_RFC3986);

Example (Java):

import java.nio.charset.StandardCharsets;
import java.util.Map;
import java.util.stream.Collectors;
import java.security.MessageDigest;
import java.util.HexFormat;

public class TokenExample {
    public static String generateToken(
            Map<String, String> data, String appsecurity) throws Exception {
        String str = data.entrySet().stream()
            .filter(entry -> !"token".equals(entry.getKey()))
            .sorted(Map.Entry.comparingByKey())
            .map(entry -> entry.getKey() + "=" + entry.getValue())
            .collect(Collectors.joining("&"));
        return digestHex(digestHex(str + appsecurity));
    }

    private static String digestHex(String value) throws Exception {
        byte[] bytes = MessageDigest.getInstance("MD5")
            .digest(value.getBytes(StandardCharsets.UTF_8));
        return HexFormat.of().formatHex(bytes);
    }
}
// 请求 URL 追加 "&token=" + URLEncoder.encode(token, StandardCharsets.UTF_8)。

Example (C#):

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Security.Cryptography;

public static class TokenExample {
    public static string GenerateToken(
            Dictionary<string, string> data, string appsecurity) {
        string str = string.Join("&", data
            .Where(entry => entry.Key != "token")
            .OrderBy(entry => entry.Key, StringComparer.Ordinal)
            .Select(entry => entry.Key + "=" + entry.Value));
        return DigestHex(DigestHex(str + appsecurity));
    }

    private static string DigestHex(string value) {
        using (var digest = MD5.Create()) {
            byte[] result = digest.ComputeHash(Encoding.UTF8.GetBytes(value));
            return BitConverter.ToString(result).Replace("-", "").ToLowerInvariant();
        }
    }
}
// 请求 URL 追加 "&token=" + Uri.EscapeDataString(token)。

Query by Flight Date + Route + Flight Number:

Request URL:

https://open-al.variflight.com/api/carbonEmission?appid=${appid}&arr=SHA&dep=PEK&fdate=2022-03-16&fnum=ZH1557&lang=&token=${token}

The parameter part in the URL is:

appid=${appid}&arr=SHA&dep=PEK&fdate=2022-03-16&fnum=ZH1557&lang=&token=${token}

Generating the encrypted string:

str = appid=${appid}&arr=SHA&dep=PEK&fdate=2022-03-16&fnum=ZH1557&lang=

Step2. The registration code is '${appsecurity}'. Assign this value to the variable $appsecurity.

Append appsecurity (the registration code) directly to str, with no extra separator.
Apply MD5 twice. Each result is a 32-character lowercase hexadecimal string. The second digest takes the UTF-8 bytes of the first Hex string, not its raw digest bytes.

token = md5Hex(md5Hex(str + appsecurity))

Note: $appsecurity=Registration code

API Endpoints

The request URL:

https://open-al.variflight.com/api/carbonEmission?

The way to request: GET

The format of return: json

Request parameter Details

Carbon Emissions V2.0 employs an authorized authentication interface. At the beginning of the cooperation, VariFlight will apply on behalf of the third party to allocate user identification codes and registration codes (i.e., appid and appsecurity).

1 Response 1

Inquiry Method: 1: Query by Flight Date + Route + Flight Number

Request parameter Description Example Required or Optional Parameter
Type
dep Departure Airport Code PEK Yes string
lang Optional. Defaults to Chinese; returns English when set to "en". No string
appid App ID Yes string
arr Arrival Airport Code SHA Yes string
token Token Yes string
fnum Flight Number ZH1557 Yes string
fdate Flight Date 2022-03-16 Yes string

Inquiry Method: 2: Query by Date + Route

Request parameter Description Example Required or Optional Parameter
Type
lang Optional. Defaults to Chinese; returns English when set to "en". No string
appid App ID Yes string
token Token Yes string
fdate Flight Date 2022-03-16 Yes string
dep Departure Airport Code PEK Yes string
arr Arrival Airport Code SHA Yes string

Inquiry Method: 3: Query by Date + Aircraft Number

Request parameter Description Example Required or Optional Parameter
Type
lang Optional. Defaults to Chinese; returns English when set to "en". No string
appid App ID Yes string
token Token Yes string
fdate Flight Date 2022-03-16 Yes string
regno Aircraft Registration Number B6961 Yes string

Return Parameter Details

Request parameter Description Example Parameter
Type
fnum Flight Number ZH1557 string
dep Departure Airport Code PEK string
arr Arrival Airport Code SHA string
regno Aircraft Registration Number B6961 string
ftypecode Aircraft type 3-letter code or 4-letter code A321 string
fdate Flight Date 2022-03-16 string
carbon_emissions Unit: kg 18385.39 number

Return Parameter Examples

Example 1: Failed return

{
  "error_code": 3,
  "error": "Lack of parameters or parameter identification failed"
}

Example 2: Successful return

[ {
  "fnum" : "ZH1557",
  "dep" : "PEK",
  "arr" : "SHA",
  "regno" : "B6961",
  "ftypecode" : "A321",
  "fdate" : "2022-03-16",
  "carbon_emissions" : 18385.39
} ]

Error Responses

Return parameter Description Trigger Scene Suggestions
0 No data permissions
2 The visiting ip have not been joined in white list
3 This request method has no permission temporarily
3 Lack of parameters or parameter identification failed
3 wrong flight number format
3 wrong departure airport format
3 wrong arrival airport format
10 No data
4 The current interface is expired
4 The current interface is closed
4 No data permissions
1 Pending review
11 Unknown error
0 Invalid user