CurrentDebrief
Sign In Sign Up
REST API SPECIFICATION vv1.2

Developer REST API & Feeds

High-frequency programmatic access to verified corporate entities, corridor hauliers, and macroeconomic indicators.

Authentication & Protocol Standards

The CurrentDebrief API is served over secure HTTPS (TLS 1.3). Authenticate all programmatic requests using an active API key passed in the standard Authorization Bearer header:

BASE URL: https://www.currentdebrief.com/api/v1/
Format: JSON & Flat CSV
Pilot Mode: Sandbox & Early Access
Auth Header: Authorization: Bearer <KEY>
Rate Limits: Tier-Controlled

API Access Tiers & Pricing

Free Sandbox Evaluation

$0
free evaluation

Instant testing access to evaluate endpoints, schemas, and regional entity attributes.

  • Rate limit: 5 requests / min
  • 250 Test Evaluation Calls / Month
  • Strict 5 requests / min rate limit
  • Sample 4-row payload with masked contacts
  • Interactive documentation & schema validation
  • Standard Bearer token authentication
Commercial Pilot

Developer API

$79
per month (pre-launch pilot)

For developers and automated apps integrating verified trade credentials directly into CRM/ERP workflows.

  • Rate limit: 60 requests / min
  • 10,000 Programmatic Calls / Month
  • Full Unmasked Entity Payloads
  • Country & Sector Filtering
  • Header Bearer Token Authentication

Commercial Pipeline

$199
per month (pre-launch pilot)

For logistics aggregators and risk underwriting engines requiring high-throughput data extraction.

  • Rate limit: 300 requests / min
  • 50,000 Programmatic Calls / Month
  • Full Warehouse Synchronization
  • Macroeconomic Time Series Access
  • Dedicated Support Channel

Core API Endpoints

POST /api/v1/clients/register
Public (No Auth)

Instant programmatic client onboarding. Provisions an active API key for automated workflows and data integration pipelines.

curl -X POST "https://www.currentdebrief.com/api/v1/clients/register" \
  -H "Content-Type: application/json" \
  -d '{"company_name": "Acme Global Trading", "contact_email": "ops@acmeglobal.com"}'
GET /api/v1/export/b2b-leads
Requires API Key

Query catalogued corporate entity records. Filters: ?country=ZW, ?sector=Logistics, ?has_phone=true, ?limit=100, and ?format=json (or csv).

# Standard Bearer Header Authentication
curl -X GET "https://www.currentdebrief.com/api/v1/export/b2b-leads?country=ZW&has_phone=true&format=json" \
  -H "Authorization: Bearer YOUR_API_KEY"
GET /api/v1/export/macro-data
Requires API Key

Extracts macroeconomic and commodity benchmarks. Filters: ?metric_code=USD_ZAR, ?category=energy, ?date_from=2024-01-01, and ?format=json.

curl -X GET "https://www.currentdebrief.com/api/v1/export/macro-data?format=json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Python 3 Client (Bearer Authentication)

import os
import requests

# Use your provisioned API key from your environment or dashboard
API_KEY = os.environ.get("CURRENTDEBRIEF_API_KEY", "YOUR_API_KEY")
url = "https://www.currentdebrief.com/api/v1/export/b2b-leads"

headers = {
    "Authorization": f"Bearer {API_KEY}",
    "Accept": "application/json"
}
params = {
    "country": "ZW",
    "has_phone": "true",
    "limit": 10
}

response = requests.get(url, headers=headers, params=params)
payload = response.json()

if payload.get("success"):
    print(f"Total returned: {payload.get('count')} records")
    for entity in payload.get("data", []):
        print(f"• {entity['company_name']} ({entity['registration_number']})")
        print(f"  LEI: {entity.get('lei_code')} | Score: {int(entity['data_quality_score']*100)}%")
        print(f"  Department: {entity.get('department_role', 'Commercial Operations Desk')}")
        print(f"  Email: {entity['contact_email']}\n")

Node.js / TypeScript Client Implementation

// Node.js v18+ Native Fetch with Bearer Auth
const API_KEY = process.env.CURRENTDEBRIEF_API_KEY || "YOUR_API_KEY";
const url = "https://www.currentdebrief.com/api/v1/export/b2b-leads?country=ZW&limit=10";

async function syncCorporateRegistry() {
    const res = await fetch(url, {
        headers: {
            "Authorization": `Bearer ${API_KEY}`,
            "Accept": "application/json"
        }
    });
    const data = await res.json();
    if (data.success) {
        console.log(`Fetched ${data.data.length} records:`);
        data.data.forEach(ent => {
            console.log(`• ${ent.company_name} [${ent.registration_number}] - Score: ${ent.data_quality_score}`);
        });
    }
}
syncCorporateRegistry();

Complete JSON Response Schemas

REST API v1 Validated

Both programmatic endpoints return strictly typed JSON envelopes with ISO 8601 timestamps, standardized error codes, and structured field payloads.

1. B2B Corporate Entity Payload (/api/v1/export/b2b-leads)

{
  "success": true,
  "count": 1,
  "total_catalog_entities": 400,
  "tier": "pro",
  "data": [
    {
      "id": 142,
      "company_name": "Bakers Inn Logistics",
      "registration_number": "CR-2018-9124",
      "lei_code": null,
      "statutory_authority": "DCIP (Companies Registry, Zimbabwe)",
      "industry_sector": "Cross-Border Logistics & Freight",
      "department_role": "Head of Regional Transit Operations",
      "contact_email": "operations@bakerslogistics.co.zw",
      "website_url": "https://bakerslogistics.co.zw",
      "address_line1": "12 Douglas Road, Workington",
      "city": "Harare",
      "country_code": "ZW",
      "country_name": "Zimbabwe",
      "employee_count_range": "250-500",
      "year_founded": "2008",
      "trade_corridor": "North-South Corridor (Beitbridge-Chirundu)",
      "hs_codes": "8701.20, 8704.23",
      "annual_trade_value_usd": 680000000.0,
      "primary_product": "Refrigerated freight transit, bulk dry haulage, and bonded carrier clearance",
      "company_description": "Cross-border carrier operating transport services between regional corridors.",
      "data_quality_score": 0.80,
      "intent_score": 0.85,
      "has_active_triggers": true,
      "latest_trigger": {
        "event_type": "TENDER_AWARD",
        "title": "Cross-Border Transit Bond Renewal",
        "event_date": "2024-10-08"
      },
      "transaction_date": "2024-10-14",
      "created_at": "2024-10-14T08:00:00Z"
    }
  ]
}

2. Macroeconomic Indicator Payload (/api/v1/export/macro-data)

{
  "success": true,
  "count": 1,
  "data": [
    {
      "id": 85,
      "source_id": 1,
      "metric_code": "COMM_COPPER_LME",
      "metric_label": "LME Grade A Copper Cash Benchmark",
      "category": "COMMODITY_PRICE",
      "value": 9820.5000,
      "unit": "USD/tonne",
      "currency_code": "USD",
      "country_code": "ZM",
      "region": "Southern & Central Africa (Copperbelt)",
      "transaction_date": "2024-10-11",
      "created_at": "2024-10-14T08:00:00Z"
    }
  ]
}

Flat CSV Export Column Dictionary

Universal Column Specification

All CSV exports generated via the web directory ("Export Filtered CSV"), sector pages ("Export Sector CSV"), or the programmatic REST endpoint adhere to the following 22-column specification:

Column Name Data Type Description & Verification Source Sample Value Free vs Pro Policy
company_name String Statutory registered business or trading corporate name. Bakers Inn Logistics Unmasked
registration_number String Official national registrar filing number (CIPC, DCIP, BRS, CAC). CR-2018-9124 Unmasked
lei_code String (20) ISO 17442 Legal Entity Identifier (populated only if verified in GLEIF; otherwise blank/null). — (Null if unlisted in GLEIF) Unmasked
statutory_authority String Regulatory agency holding the primary incorporation gazette. DCIP Harare / CIPC Pretoria Unmasked
industry_sector String Standardized commercial classification across core sectors. Supply Chain & Logistics Unmasked
country_code ISO-3166-1 Two-letter jurisdiction code (ZA, ZW, KE, NG, BW). ZW Unmasked
city String Commercial hub, port municipality, or registered depot. Harare / Bulawayo Unmasked
address_line1 String Physical corporate headquarters or terminal depot address. 12 Douglas Road, Workington Unmasked
department_role String Corporate decision-maker position or commercial desk (e.g. Head of Commercial Logistics). Head of Commercial Logistics Unmasked
contact_email RFC 5322 Company-level generic business email (e.g. operations@, info@, sales@). Personal contacts are out of scope. ops@bakerslogistics.co.zw Masked on Free; Full on Pro
website_url URL Corporate web portal or business domain. https://bakerslogistics.co.zw Unmasked
employee_count_range String Firmographic headcount bracket. 50-200 / 250-500 Unmasked
annual_trade_value_usd Numeric Turnover estimate derived from headcount (Modelled estimate). 680000000.00 Unmasked
trade_corridor String Active regional transport or export corridor. North-South (Durban-Harare) Unmasked
hs_codes String Harmonized System tariff classifications for primary freight. 8701.20, 8704.23 Unmasked
primary_product Text Core commercial products, haulage specializations, or offerings. Corridor bulk freight transit Unmasked
data_quality_score Float (0-1) Profile completeness metric (0.0 to 1.0 based on 5 milestones). 0.80 Unmasked
intent_score Float (0-1) Commercial momentum score derived from recent tenders and filings. 0.85 Unmasked
transaction_date ISO-8601 Date Timestamp of latest statutory corroboration pass. 2024-10-14 Unmasked

Need Custom Corridor Feeds or Alternative Datasets?

Our team builds custom corridor lead extractions, scheduled data exports, and programmatic API access.

Contact Solutions Engineering

Provision API Credentials

Programmatic REST API delivery for B2B company registries, LEI verification, and macro telemetry feeds.

Sandbox Evaluation 250 test calls / month • 5 requests / min • Masked 4-row schema inspection.
Commercial Pilot Tier 10,000 calls / month • 60 requests / min • ~45ms median response.

Enterprise Commercial Paywall

Direct corporate contact channels, unmasked phone lines, and full commercial registries are restricted assets. Choose an option below to proceed:

Account Required for Sample (4 Rows)
Create a free account or sign in to unlock instant sample downloads.
Sign Up Free Sign In
Unlock Full Unmasked Dataset
Instant Access
Complete commercial directory listings, direct contact gateways, and trade corridor data. Pre-launch pilot access available via inquiry.
View Plans & Request Access
Questions or custom corridor requests? Contact Data Team (enterprise@currentdebrief.com)