Skip to main content
GET
/
v1
/
macro-report
Get Macro Report
curl --request GET \
  --url https://api.chicago.global/v1/macro-report \
  --header 'Authorization: Bearer <token>'
{
"success": true,
"market": "United States",
"report_date": "2024-01-15",
"format": "json",
"file_url": "https://storage.example.com/reports/us-2024-01-15.json",
"content": null
}
This is a synchronous endpoint - results are returned immediately without job polling.

Response Formats

JSON Format (default)

When format=json, the response includes the report file URL:
{
  "success": true,
  "market": "United States",
  "report_date": "2024-01-15",
  "format": "json",
  "file_url": "https://storage.example.com/reports/us-2024-01-15.json",
  "content": null
}
When include_content=true, the content field contains the full report data instead of null.

PDF Format

When format=pdf, the response includes the PDF URL:
{
  "success": true,
  "market": "United States",
  "report_date": "2024-01-15",
  "format": "pdf",
  "pdf_url": "https://storage.example.com/reports/us-2024-01-15.pdf"
}

List Available Markets

To get a list of all markets with available reports:
GET /v1/macro-report/markets
{
  "success": true,
  "markets": ["China", "Germany", "Japan", "United States"]
}

Example: Fetch Report with Content

const response = await fetch(
  'https://api.chicago.global/v1/macro-report?market=United%20States&include_content=true',
  {
    headers: { 'Authorization': `Bearer ${API_KEY}` }
  }
);

const report = await response.json();

if (report.success) {
  console.log(`Market: ${report.market}`);
  console.log(`Report Date: ${report.report_date}`);
  console.log(`Content:`, report.content);
}

Authorizations

Authorization
string
header
required

API key passed as Bearer token

Query Parameters

market
string
required

Market name (e.g., 'United States', 'Japan', 'Germany')

format
enum<string>
default:json

Response format: 'json' or 'pdf'

Available options:
json,
pdf
include_content
boolean
default:false

For JSON format: embed the full report content in the response

date
string<date>

Report date in YYYY-MM-DD format. Omit to get the latest report.

Response

Macro report retrieved successfully

success
boolean

Whether the request was successful

market
string

Market name

report_date
string<date>

Report date

format
enum<string>

Response format

Available options:
json,
pdf
file_url
string | null

URL to JSON report file (when format=json)

content
object

Full report content (when format=json and include_content=true)

pdf_url
string | null

URL to PDF report file (when format=pdf)