Business Radar API · v0.0.1 (v3)
Business Radar API reference
The Business Radar REST API returns the same company, compliance and adverse-media data the app shows: register companies in a portfolio, run compliance checks against sanction and PEP lists, and read the news articles matched to the companies you monitor. Requests go to https://api.businessradar.com over HTTPS and authenticate with a bearer token in the Authorization header. List endpoints are cursor-paginated; long-running work is started with a POST and polled.
New here? The API guides walk through a first authenticated request, a compliance check and portfolio news monitoring, each with runnable curl, Python, TypeScript and PHP. The full reference below is generated from the live OpenAPI schema.
The whole reference is also available as one Markdown file — every endpoint, parameter and schema — at https://help.businessradar.com/api.md, for AI assistants, LLMs and anyone who would rather read text. The help center index for LLMs is at https://help.businessradar.com/llms.txt.
What the API covers
- Webhooks13 endpoints
- Companies10 endpoints
- Articles7 endpoints
- Portfolios5 endpoints
- Compliance4 endpoints
- Pythonv1.29.0
pip install businessradar - TypeScriptv0.9.0
npm install @businessradar/businessradar - PHPv0.7.0
composer require "businessradar/businessradar 0.7.0"
Authentication
Every endpoint below needs an API key. Request one from support@businessradar.com, then send it on every request in the Authorization header. The same key works in the Authorize panel on this page, so you can try any endpoint here before writing code.
- Base URL
https://api.businessradar.com- Header
Authorization: Bearer <token>- Scheme
tokenAuth— HTTP bearer token
Keys are secrets: keep them server-side, out of source control and out of browser code. Read the key from an environment variable — all three clients pick up BUSINESSRADAR_API_KEY on their own.
Your first request
curl -sS https://api.businessradar.com/ext/v3/portfolios \
-H "Authorization: Bearer $BUSINESSRADAR_API_KEY"import os
from businessradar import BusinessRadar
client = BusinessRadar(api_key=os.environ["BUSINESSRADAR_API_KEY"])
page = client.portfolios.list()
print(page.results)import BusinessRadar from '@businessradar/businessradar';
const client = new BusinessRadar({ apiKey: process.env['BUSINESSRADAR_API_KEY'] });
const page = await client.portfolios.list();
console.log(page.results);<?php
use Businessradar\Client;
$client = new Client(apiKey: getenv('BUSINESSRADAR_API_KEY'));
$page = $client->portfolios->list();
var_dump($page->getItems());When the key is wrong or missing
- 401Authentication credentials were not provided.
{ "detail": "Authentication credentials were not provided." } - 403You do not have permission to perform this action.
{ "detail": "You do not have permission to perform this action." } - 429You have exceeded your request rate. Please try again later.
{ "detail": "You have exceeded your request rate. Please try again later." }
New to the API? Start with the step-by-step guides.