PigSignal API Documentation
Structured supply intelligence for the global swine industry. Four endpoints return typed quantitative signals designed for AI agent consumption and enterprise decision systems.
Quick Start
All requests are made to the base URL below. Include your API key in the X-API-Key header on every request.
https://pigsignal.io/api/v1Authentication
PigSignal uses API key authentication. Pass your API key in the X-API-Key header with every request.
X-API-Key: YOUR_API_KEYBenchmark API
Returns regional reproduction benchmarks for PSY, LSY, farrowing rate, NPD, and litter metrics. N≥10 anonymized from 150M+ records across 18+ countries.
Parameters
| Parameter | Type | Description | |
|---|---|---|---|
| region | string | optional | Region name such as 충남, 경기, or 전북. Omit for national coverage. |
| year | integer | optional | Analysis year. Available range: 2023–2025. Default: 2024. |
Example Response Shape
{
"meta": {
"year": <integer>,
"anonymization": { "min_farms_threshold": 10 }
},
"data": [{
"region_name": <string>,
"farm_count": <integer>,
"psy": { <statistic>: <number>, ... },
"farrowing_rate": { <statistic>: <number>, ... }
}]
}Field shape only. Actual benchmark values depend on the requested year, region and the eligible farm population at request time. Regional aggregates are returned only where the minimum farm threshold is met.
Supply Signals API
Returns quarterly and monthly supply indicators for Korean and global swine markets, including herd size trends, slaughter volume changes, and regional variance. Monitor inventory, production and trade data, together with transparent derived metrics such as year-over-year change, moving averages and market concentration. Data is updated according to the publication schedule of each source.
Signals are descriptive indicators derived from observed data and are not forecasts or predictions.
Parameters
| Parameter | Type | Description | |
|---|---|---|---|
| region | string | required | ISO region code. See Regions reference. |
| period | string | required | Period in YYYY-QN format. E.g. 2026-Q3. |
| include_breakdown | boolean | optional | Include regional sub-breakdown in response. Default false. |
Example Request
curl -X GET \ "https://pigsignal.io/api/v1/benchmarks/supply-forecast?region=KR&period=2026-Q3" \ -H "X-API-Key: YOUR_API_KEY" \ -H "Accept: application/json"
Example Response
{
"status": "ok",
"region": "KR",
"period": "2026-Q3",
"supply_index": 94.2, // 100 = 5-year baseline
"trend": "DECLINING",
"yoy_change_pct": -3.8,
"confidence": 0.91
}Risk Signals API
Returns observed indicators for supply, disease reporting, and market stress, derived from 150M+ records and 12 years of historical data.
Parameters
| Parameter | Type | Description | |
|---|---|---|---|
| region | string | required | ISO region code. See Regions reference. |
| risk_types | string[] | optional | Risk types to filter: disease, supply, weather, market. Default: all. |
| threshold | float | optional | Minimum risk_score to include signals. Range 0.0–1.0. Default: 0.3. |
Example Response
{
"status": "ok",
"region": "KR",
"risk_level": "ELEVATED",
"risk_score": 0.74, // 0.0–1.0
"signals": [
{ "type": "DISEASE_PROXIMITY", "severity": "HIGH" },
{ "type": "SUPPLY_CONCENTRATION", "severity": "MEDIUM" }
]
}Market Intelligence API
Returns weekly global market intelligence briefings including pork price movements, supply dynamics, and regional risk factors. Delivered as structured JSON and PDF digest.
Parameters
| Parameter | Type | Description | |
|---|---|---|---|
| week | string | optional | ISO week in YYYY-WNN format. Defaults to latest available. |
| format | string | optional | Response format: json or pdf. Default: json. |
| regions | string[] | optional | List of region codes to include. Default: all available. |
Error Codes
PigSignal uses standard HTTP status codes. Errors return a JSON body with a detail field.
| Code | Meaning |
|---|---|
| 401 | Missing or invalid API key. |
| 403 | Your plan does not include this endpoint. |
| 429 | Rate limit exceeded. Check your plan limits. |
| 503 | Temporary service outage. Retry with exponential backoff. |
Integration Notes
PigSignal responses use stable field names, explicit types, and versioned endpoints so agents can parse benchmark and supply signals without scraping prose.
Region Codes
Use these region codes in the region parameter. KR is the most data-dense region with 12+ years of coverage.
| Code | Meaning | Coverage |
|---|---|---|
| KR | South Korea | Full coverage · 12+ years · 150M+ records |
| KR-NORTH | Northern Korea (Gyeonggi, Gangwon) | Regional subset of KR |
| KR-SOUTH | Southern Korea (Jeolla, Gyeongsang) | Regional subset of KR |
| GLOBAL | Aggregated global index (KR-weighted) | Composite index · 18+ countries |