{"openapi":"3.1.0","info":{"title":"ETFYield Lab REST API","version":"1.0.0","description":"Read-only HTTP JSON endpoints published by ETFYield Lab for looking up financial broker license numbers, verifying registered broker website domains, and querying regulator warning records.","termsOfService":"https://etfyieldlab.com/about","license":{"name":"CC BY 4.0","url":"https://creativecommons.org/licenses/by/4.0/"}},"servers":[{"url":"https://etfyieldlab.com","description":"ETFYield Lab Production API"}],"paths":{"/api/v1/verify/license":{"get":{"operationId":"verifyLicenseNumber","summary":"Verify regulatory license certificate number","description":"Verify a regulatory licence or certificate number against structured supervisory filings and retrieve official register lookup links.","parameters":[{"name":"number","in":"query","required":true,"schema":{"type":"string"},"description":"Certificate, FRN, AFSL, or MSB number"},{"name":"regulator","in":"query","required":false,"schema":{"type":"string"},"description":"Optional regulator short code (e.g. FCA, FinCEN, ASIC)"}],"responses":{"200":{"description":"Structured licence match verdict with SHA-256 integrity hash","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Missing required query parameter number"}}}},"/api/v1/verify/domain":{"get":{"operationId":"verifyBrokerDomain","summary":"Verify official broker domain against clone phishing","description":"Check a domain against regulator clone warnings and licensed institutions.","parameters":[{"name":"host","in":"query","required":true,"schema":{"type":"string"},"description":"Domain or URL to verify"}],"responses":{"200":{"description":"Domain safety verdict, warning matches, and matched institutions","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Missing required query parameter host"}}}},"/api/v1/brokers/{slug}":{"get":{"operationId":"getInstitutionScorecard","summary":"Retrieve broker or digital asset regulatory dossier","description":"Retrieve 6D compliance scorecard, regulatory dossier, and licences for a covered institution.","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string"},"description":"Institution slug"}],"responses":{"200":{"description":"Structured 6D scorecard with official regulator verification URLs","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Institution outside this publication coverage slice"}}}},"/api/v1/markets/{provider}/{symbol}":{"get":{"operationId":"getMarketContractSpecification","summary":"Retrieve exchange contract specification & liquidity audit","description":"Retrieve structured exchange contract specifications, tick/lot precision, margin parameters, and liquidity audit telemetry for a provider and instrument symbol.","parameters":[{"name":"provider","in":"path","required":true,"schema":{"type":"string"},"description":"Exchange or liquidity provider slug (e.g. binance, okx, bybit)"},{"name":"symbol","in":"path","required":true,"schema":{"type":"string"},"description":"Market instrument or contract symbol (e.g. BTCUSDT, ETH-USDT-SWAP)"}],"responses":{"200":{"description":"Structured exchange contract specification and liquidity audit payload","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Market provider or contract symbol not found"}}}},"/api/v1/compare/{pair}":{"get":{"operationId":"getEntityComparisonMatrix","summary":"Retrieve 1v1 entity regulatory & fee comparison matrix","description":"Retrieve head-to-head 1v1 regulatory standing, 6D compliance score differential, and fee comparison matrix for two covered institutions.","parameters":[{"name":"pair","in":"path","required":true,"schema":{"type":"string"},"description":"Comparison pair slug formatted as {slugA}-vs-{slugB}"}],"responses":{"200":{"description":"Structured 1v1 entity regulatory and fee comparison matrix","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"One or both entities in comparison pair not found"}}}},"/api/v1/rankings/{facet}":{"get":{"operationId":"getFacetedRegulatoryLeaderboard","summary":"Retrieve faceted regulatory leaderboard","description":"Retrieve ranked institutional leaderboard filtered by regulatory jurisdiction, licence tier, or asset class facet.","parameters":[{"name":"facet","in":"path","required":true,"schema":{"type":"string"},"description":"Leaderboard facet slug (e.g. overall, fca, asic, tier-1, low-risk)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"description":"Optional maximum number of ranked entities to return"}],"responses":{"200":{"description":"Structured faceted regulatory leaderboard with ranked institutions and 6D scores","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Unknown ranking facet"}}}},"/api/badge/{slug}":{"get":{"operationId":"getRegulatoryTrustScoreBadge","summary":"Render SVG regulatory trust score badge","description":"Render an embeddable vector SVG regulatory trust score and licence verification badge for a covered institution.","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string"},"description":"Institution slug"}],"responses":{"200":{"description":"Embeddable SVG regulatory trust score badge","content":{"image/svg+xml":{"schema":{"type":"string"}}}},"404":{"description":"Institution not found"}}}}}}