ETFYield Lab REST API Documentation

Read-only HTTP JSON API for looking up financial broker license numbers, verifying registered broker website domains, and checking regulatory warning records across public supervisory registers (FCA, SEC, NFA, ASIC, CySEC, MAS, FINMA, BaFin).

Base URL https://etfyieldlab.com
Authentication None required (Public GET)
HTTPS & CORS HTTPS only · Access-Control-Allow-Origin: *
OpenAPI 3.1 Spec /.well-known/openapi.json

1. Look Up a Broker License Number

GET /api/v1/verify/license

Checks a regulatory license or registration number against recorded supervisory filings and returns the matching institution name, legal entity, issuing regulator, and license status.

Query Parameters

Parameter Type Required Description
number string Yes License, registration, or reference number (e.g. 208159, 414530, 0358268).
regulator string No Optional regulator short code to filter matches (e.g. FCA, ASIC, SEC, NFA, CySEC, MAS).

Example Request

curl -s "https://etfyieldlab.com/api/v1/verify/license?number=208159&regulator=FCA"

Live endpoint test: https://etfyieldlab.com/api/v1/verify/license?number=208159&regulator=FCA

Example Response (200 OK)

{
  "ok": true,
  "query": {
    "number": "208159",
    "regulator": "FCA"
  },
  "matched": true,
  "matchCount": 1,
  "matches": [
    {
      "certificateNumber": "208159",
      "regulatorShortName": "FCA",
      "regulatorFullName": "Financial Conduct Authority",
      "regulatorState": "regulated",
      "companySlug": "interactive-brokers",
      "companyName": "Interactive Brokers",
      "legalEntity": "Interactive Brokers (U.K.) Limited",
      "verifyUrl": "https://etfyieldlab.com/verify/license/208159"
    }
  ]
}

2. Verify a Broker Website Domain

GET /api/v1/verify/domain

Checks whether a hostname or URL matches an official website recorded on a licensed broker filing or appears in published regulator warning notices.

Query Parameters

Parameter Type Required Description
host string Yes Domain name or URL to check (e.g. interactivebrokers.com, ig.com). Also accepts domain as an alias.

Example Request

curl -s "https://etfyieldlab.com/api/v1/verify/domain?host=interactivebrokers.com"

Live endpoint test: https://etfyieldlab.com/api/v1/verify/domain?host=interactivebrokers.com

Example Response (200 OK)

{
  "ok": true,
  "host": "interactivebrokers.com",
  "verdict": "verified_official_domain",
  "matchedCompanies": [
    {
      "slug": "interactive-brokers",
      "name": "Interactive Brokers",
      "licenseCount": 19,
      "riskLevel": "low_risk",
      "dossierUrl": "https://etfyieldlab.com/providers/interactive-brokers"
    }
  ],
  "warningMatches": []
}

3. Get Broker Licenses and Regulatory Profile

GET /api/v1/brokers/{slug}

Returns recorded licenses, issuing regulators, registered website domains, and regulatory warning counts for a specific broker slug.

Path Parameters

Parameter Type Required Description
slug string Yes URL slug of the broker or institution (e.g. interactive-brokers, ig-group, cmc-markets, saxo-bank).

Example Request

curl -s "https://etfyieldlab.com/api/v1/brokers/interactive-brokers"

Live endpoint test: https://etfyieldlab.com/api/v1/brokers/interactive-brokers

4. Compare Two Brokers

GET /api/v1/compare/{slugA}-vs-{slugB}

Returns a side-by-side comparison of two brokers' recorded regulatory licenses, jurisdictions, and warning counts.

Example Request

curl -s "https://etfyieldlab.com/api/v1/compare/ig-group-vs-interactive-brokers"

Live endpoint test: https://etfyieldlab.com/api/v1/compare/ig-group-vs-interactive-brokers

5. HTTP Status Codes & Rate Limits

Status Code Meaning
200 OK Request succeeded and returned a JSON payload.
400 Bad Request Missing required query parameter (such as number or host).
404 Not Found Requested broker slug or resource was not found.
429 Too Many Requests Rate limit exceeded (default limit: 60 requests per minute per IP).