Developer API

Integrate Accra-Helsinki environmental intelligence data directly into your applications, research tools, or customs systems using our RESTful API.

Get API Key API Status

Authentication

All API requests require a Bearer token passed in the Authorization header. You can generate a token in your developer dashboard.

Authorization: Bearer YOUR_API_KEY

Rate Limits

To ensure fair usage, API requests are rate-limited based on your account tier.

Public (Unauthenticated)100 / hour
Registered Researcher5,000 / day
Institutional PartnerUnlimited

Endpoints

GET/api/v1/countries

Retrieve a list of all African countries tracked by the platform along with basic metadata (population, GDP, regions).

Sample Response

{
  "data": [
    {
      "id": "GHA",
      "name": "Ghana",
      "region": "West Africa",
      "population": 32830000
    }
  ],
  "meta": {
    "count": 54
  }
}

GET/api/v1/research

Search the research library. Accepts query parameters: q (search string), type, category, year_start, year_end, limit, offset.

Sample Response

{
  "data": [
    {
      "id": 1,
      "title": "E-waste flow in West Africa",
      "authors": ["Mensah, A.", "Osei, K."],
      "date": "2023-10-15"
    }
  ],
  "meta": {
    "total": 150,
    "page": 1
  }
}

GET/api/v1/treaties

List international treaties and conventions related to waste and refrigerants, including African ratification status.

Sample Response

{
  "data": [
    {
      "id": "basel-convention",
      "name": "Basel Convention",
      "adoptionDate": "1989-03-22"
    }
  ]
}

GET/api/v1/refrigerants

Database of refrigerants (CFCs, HCFCs, HFCs, Naturals) with GWP, ODP, and phase-out status.

Sample Response

{
  "data": [
    {
      "ashraeNumber": "R-134a",
      "type": "HFC",
      "gwp": 1430,
      "phaseOutStatus": "Phase-down"
    }
  ]
}

POST/api/v1/compliance/check

Programmatically check if a shipment or appliance complies with national laws and international treaties.

Request Body

{
  "applianceType": "Refrigerator",
  "refrigerant": "R-12",
  "condition": "Used",
  "destinationCountry": "GHA"
}

Sample Response

{
  "status": "LIKELY NON-COMPLIANT",
  "issues": [
    "R-12 (CFC) is universally banned under the Montreal Protocol.",
    "Used refrigerators older than 5 years are banned in Ghana."
  ]
}