On this page

Curaçao data
API reference.

Get a neighborhood’s geography, census figures and linked waste schedules in one response. The API also provides public holidays, school dates, fuel and utility tariffs, price indices, visitor arrivals, statutory rates, official exchange rates, and government address points.

Base URL: https://api.korsou.dev/v1. No API key. Public GET, HEAD and OPTIONS requests. Approximately 60 requests per minute per IP.

Neighborhoods

Search for a neighborhood, then pass its ID to the context endpoint.

curl 'https://api.korsou.dev/v1/neighborhoods?q=abrahamsz'
curl 'https://api.korsou.dev/v1/neighborhoods/nbh_abrahamsz/context'

The response includes the neighborhood, its geozone, census figures and matching waste-service places. Each section includes its source, date and availability.

SectionWhat you receive
neighborhoodName, permanent ID, aliases and available population figures.
geozoneThe larger CBS area this neighborhood belongs to.
censusUp to 100 neighborhood indicators. Continue with next_cursor on the census endpoint, using the same neighborhood_id and limit=100.
wasteMatching places and up to three ongoing or future set-out windows per zone, ordered by date. has_more indicates additional dates.

Optional as_of selects waste windows from a date and defaults to today in Curaçao. It does not change the census year. Set-out windows tell residents when to put waste outside; they are not exact pickup dates.

place_match means a provider’s place name is linked to the neighborhood. It does not confirm service for every address. neighborhood_coverage means the whole neighborhood is covered. A missing match does not rule out service.

When an optional section is unavailable, the response includes its status and empty data. Matching places can still appear when waste dates are unavailable. An unknown neighborhood returns 404; unavailable neighborhood data returns 503.

Individual geography, census and waste requests

Neighborhoods

Each neighborhood has a permanent nbh_ ID, alternate names and a geozone. Population figures are included where available. Search with q or filter by geozone_id. The geography and population figures come from CBS Census 2023; the available figures do not form a complete national population total.

Geozones

CBS geographic areas use permanent gz_ IDs. Polygon geometry is not available.

Census indicators

Census 2023 theme-table indicators for the gz_ geozones and nbh_ neighborhoods in the geography API. Each indicator names the place it describes. Cite CBS when using these figures. The available figures do not form a complete national population total.

Waste collection

Find waste collection schedules by place, neighborhood or zone. Query /v1/waste_zones or /v1/waste_collections by neighborhood_id and service. Zones include named places with stable IDs and optional links to CBS neighborhoods. A link does not confirm service across the whole neighborhood. Both endpoints accept place_id, including places without a CBS link. Collection queries also accept zone_id and inclusive from/to set-out dates.

Set-out windows tell residents when to put waste outside; they are not exact pickup dates. The optional collection window is omitted when unknown. Neighborhood coverage may be incomplete; unsupported neighborhood queries return 503 dataset_unavailable. Address-based lookup is not available. An empty collection list means no published dates match the query. Collection may still take place. See dataset metadata for availability and source reuse terms.

Calendars

Request public holidays and school vacation ranges separately. Holiday responses include local names and observed dates; school responses include inclusive start and end dates.

curl 'https://api.korsou.dev/v1/holidays/2026'
curl 'https://api.korsou.dev/v1/school_vacations?school_year=2026-2027'

Public holidays

Calendars are available for 2025 and 2026. Dates follow America/Curacao. A holiday ID stays the same each year. ID + date identifies one occurrence. The next-holiday endpoint includes today and uses the observed date when one is available. New Year’s Eve is partial; the government source does not specify hours. School and employment arrangements can differ from these dates.

School vacations

School vacation dates from government rosters for school years 2024–2025 through 2028–2029. Start and end dates are inclusive. Filter with school_year. School vacations are separate from the public holidays in /v1/holidays.

Tariffs

Fuel, electricity and water observations from government advertisements and decrees. Amounts keep the printed currency; the API does not convert NAF, NAf, CMg or Cg.

curl 'https://api.korsou.dev/v1/tariffs?product=mogas_95&limit=3'

Consumer price index

Overall CPI covers January 2024 through August 2026. Use category_code=total for this series. Detail for 47 CBS expenditure categories, including TOTAL, covers January 2025 through August 2026. All index levels use average 2023 = 100.

The 2024 rows omit monthly_change_percent and weight_2016 because the source table does not report them. Monthly change compares consecutive months. The inflation rate based on 12-month averages is not included.

Filter by period (YYYY-MM) or category_code. Category codes are slugs of CBS labels, not UN COICOP codes. Cite CBS when using these figures.

curl 'https://api.korsou.dev/v1/cpi?category_code=total&limit=100'

Visitor arrivals

Monthly stayover, cruise and day-tripper totals. Filter with period or metric. A market field appears only when the source names one. Cite the source when using these figures. Check dataset metadata for availability and reuse terms.

curl 'https://api.korsou.dev/v1/tourism_arrivals?period=2026-09'
curl 'https://api.korsou.dev/v1/tourism_arrivals?market=united_states'

Statutory rates

Minimum wage, poverty line and contribution-ceiling observations. Each record identifies its applicability: employee age range and gross or net pay, household composition, or insurance scheme. Filter households with adults and children, or ceilings with kind=contribution_ceiling. Amounts keep the printed currency. These records are not a government document or a payroll calculation.

curl 'https://api.korsou.dev/v1/statutory_rates?kind=poverty_line'
curl 'https://api.korsou.dev/v1/statutory_rates?kind=contribution_ceiling'

Official exchange rates

Working-day rates from the Centrale Bank van Curaçao en Sint Maarten for use by commercial banks. Each row is one published currency on one rate date, with buy notes, buy cheques/transfers and sell as printed. A second selling rate appears as sell_cheques when the bank prints one. Filter with currency, from or to. Weekends and bank holidays are omitted when the bank did not publish a row. These records are not a bank quote or a conversion service. Check dataset metadata for availability and reuse terms.

curl 'https://api.korsou.dev/v1/official_exchange_rates?currency=us_dollar'

Addresses & street names

Government of Curaçao / VVRP Basiskaart address points retrieved on 19 October 2026. The dataset includes 50,068 address points and 2,595 distinct names. The source update date is unknown. Coverage is incomplete and postal deliverability is not verified.

Curaçao has no national postcodes. /v1/addressing/profile returns country_code CW and has_postal_codes false. Use /v1/localities for neighborhood IDs and /v1/addressing/suggest to autocomplete localities, streets and addresses. Search with q; filter addresses with street_id and an exact house_number. Responses include formatted_address, coordinates and permanent adr_/str_ IDs. Source names retain their spelling and capitalization. Street records group address names, which may include area names; they are not physical road segments. Address points have no neighborhood relationships. Do not infer them from similar names or invent postcodes.

Source license: Unknown.

Endpoint reference

Use limit to request up to 100 records per page from a collection. Pass the returned cursor unchanged to get the next page. Cursors belong to a specific query and dataset version. Start again when a dataset update invalidates your cursor. Errors include a stable code and request ID. ETags exclude request-specific metadata; pass If-None-Match for conditional reads.

Discover the API

GET/v1
curl 'https://api.korsou.dev/v1'
Open in browser ↗
Request and response schemas
{
  "summary": "Discover the API",
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "enum": [
                      "Kòrsou.dev API"
                    ]
                  },
                  "version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  },
                  "country": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string",
                        "enum": [
                          "Curaçao"
                        ]
                      },
                      "code": {
                        "type": "string",
                        "enum": [
                          "CW"
                        ]
                      }
                    },
                    "required": [
                      "name",
                      "code"
                    ]
                  },
                  "documentation": {
                    "type": "string",
                    "format": "uri"
                  },
                  "openapi": {
                    "type": "string",
                    "format": "uri"
                  },
                  "datasets": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^[a-z][a-z0-9_]{0,79}$"
                        },
                        "path": {
                          "type": "string"
                        },
                        "metadata": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "id",
                        "path",
                        "metadata"
                      ]
                    }
                  },
                  "notice": {
                    "type": "string"
                  }
                },
                "required": [
                  "name",
                  "version",
                  "country",
                  "documentation",
                  "openapi",
                  "datasets",
                  "notice"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

API health status

GET/v1/health
curl 'https://api.korsou.dev/v1/health'
Open in browser ↗
Request and response schemas
{
  "summary": "API health status",
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "object",
                "properties": {
                  "status": {
                    "type": "string",
                    "enum": [
                      "ok"
                    ]
                  }
                },
                "required": [
                  "status"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Dataset availability and provenance

GET/v1/datasets/{id}
ParameterInRequired
idpathRequired
curl 'https://api.korsou.dev/v1/datasets/holidays'
Open in browser ↗
Request and response schemas
{
  "summary": "Dataset availability and provenance",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "pattern": "^[a-z][a-z0-9_]{0,79}$"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^[a-z][a-z0-9_]{0,79}$"
                  },
                  "name": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string",
                    "enum": [
                      "available",
                      "unavailable"
                    ]
                  },
                  "version": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "last_updated": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "record_count": {
                    "type": "integer"
                  },
                  "source": {
                    "type": "object",
                    "properties": {
                      "authority": {
                        "type": "string"
                      },
                      "url": {
                        "type": "string",
                        "format": "uri"
                      },
                      "redistribution_status": {
                        "type": "string",
                        "enum": [
                          "permitted",
                          "restricted",
                          "unknown",
                          "internal_only"
                        ]
                      },
                      "contributors": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "minLength": 1
                            },
                            "authority": {
                              "type": "string",
                              "minLength": 1
                            },
                            "url": {
                              "type": "string",
                              "format": "uri"
                            },
                            "redistribution_status": {
                              "type": "string",
                              "enum": [
                                "permitted",
                                "restricted",
                                "unknown",
                                "internal_only"
                              ]
                            },
                            "license": {
                              "type": [
                                "string",
                                "null"
                              ]
                            }
                          },
                          "required": [
                            "id",
                            "authority",
                            "url",
                            "redistribution_status",
                            "license"
                          ]
                        },
                        "minItems": 2
                      }
                    },
                    "required": [
                      "authority",
                      "url",
                      "redistribution_status"
                    ]
                  },
                  "license": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "formats": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "enum": [
                        "json"
                      ]
                    }
                  }
                },
                "required": [
                  "id",
                  "name",
                  "status",
                  "version",
                  "last_updated",
                  "record_count",
                  "source",
                  "license",
                  "formats"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Public holidays by year

GET/v1/holidays

Omit year to use the current year in Curaçao.

ParameterInRequired
yearqueryOptional
curl 'https://api.korsou.dev/v1/holidays'
Open in browser ↗
Request and response schemas
{
  "summary": "Public holidays by year",
  "description": "Omit year to use the current year in Curaçao.",
  "parameters": [
    {
      "name": "year",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "minimum": 2025,
        "maximum": 2100,
        "example": 2026
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Holiday"
                }
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  },
                  "pagination": {
                    "type": "object",
                    "properties": {
                      "limit": {
                        "type": "integer"
                      },
                      "cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "next_cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "limit",
                      "cursor",
                      "next_cursor"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version",
                  "pagination"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Next public holiday

GET/v1/holidays/next

Returns the next holiday on or after today in Curaçao. Uses the observed date when one is available.

curl 'https://api.korsou.dev/v1/holidays/next'
Open in browser ↗
Request and response schemas
{
  "summary": "Next public holiday",
  "description": "Returns the next holiday on or after today in Curaçao. Uses the observed date when one is available.",
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "$ref": "#/components/schemas/Holiday"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Public holidays for a year

GET/v1/holidays/{year}
ParameterInRequired
yearpathRequired
curl 'https://api.korsou.dev/v1/holidays/2026'
Open in browser ↗
Request and response schemas
{
  "summary": "Public holidays for a year",
  "parameters": [
    {
      "name": "year",
      "in": "path",
      "required": true,
      "schema": {
        "type": "integer",
        "minimum": 2025,
        "maximum": 2100,
        "example": 2026
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Holiday"
                }
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  },
                  "pagination": {
                    "type": "object",
                    "properties": {
                      "limit": {
                        "type": "integer"
                      },
                      "cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "next_cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "limit",
                      "cursor",
                      "next_cursor"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version",
                  "pagination"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Search geozones

GET/v1/geozones
ParameterInRequired
limitqueryOptional
cursorqueryOptional
qqueryOptional
curl 'https://api.korsou.dev/v1/geozones'
Open in browser ↗
Request and response schemas
{
  "summary": "Search geozones",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 50
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      }
    },
    {
      "name": "q",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 120
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Geozone"
                }
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  },
                  "pagination": {
                    "type": "object",
                    "properties": {
                      "limit": {
                        "type": "integer"
                      },
                      "cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "next_cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "limit",
                      "cursor",
                      "next_cursor"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version",
                  "pagination"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Look up a permanent geozone ID

GET/v1/geozones/{id}
ParameterInRequired
idpathRequired
curl 'https://api.korsou.dev/v1/geozones/gz_example'
Open in browser ↗
Request and response schemas
{
  "summary": "Look up a permanent geozone ID",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "pattern": "^gz_[a-z0-9]+(?:_[a-z0-9]+)*$"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "$ref": "#/components/schemas/Geozone"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Search neighborhoods

GET/v1/neighborhoods

Search names and aliases, or filter by geozone.

ParameterInRequired
limitqueryOptional
cursorqueryOptional
qqueryOptional
geozone_idqueryOptional
curl 'https://api.korsou.dev/v1/neighborhoods'
Open in browser ↗
Request and response schemas
{
  "summary": "Search neighborhoods",
  "description": "Search names and aliases, or filter by geozone.",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 50
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      }
    },
    {
      "name": "q",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 120
      }
    },
    {
      "name": "geozone_id",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^gz_[a-z0-9]+(?:_[a-z0-9]+)*$"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Neighborhood"
                }
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  },
                  "pagination": {
                    "type": "object",
                    "properties": {
                      "limit": {
                        "type": "integer"
                      },
                      "cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "next_cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "limit",
                      "cursor",
                      "next_cursor"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version",
                  "pagination"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Look up a permanent neighborhood ID

GET/v1/neighborhoods/{id}
ParameterInRequired
idpathRequired
curl 'https://api.korsou.dev/v1/neighborhoods/nbh_barber'
Open in browser ↗
Request and response schemas
{
  "summary": "Look up a permanent neighborhood ID",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "pattern": "^nbh_[a-z0-9]+(?:_[a-z0-9]+)*$"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "$ref": "#/components/schemas/Neighborhood"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Neighborhood geography, census and upcoming waste schedules

GET/v1/neighborhoods/{id}/context

Get the neighborhood, its geozone, census figures and linked waste schedules. Each section includes its source and availability; missing optional data does not block the response. Census returns up to 100 indicators. Continue with next_cursor on /v1/census_indicators, using the same neighborhood_id and limit=100. Waste returns up to three ongoing or future set-out windows per matched zone, ordered by start date. has_more indicates additional windows. as_of defaults to today in America/Curacao. A place_match links a provider place to the neighborhood, without confirming service for every address. no_match does not rule out service.

ParameterInRequired
idpathRequired
as_ofqueryOptional
curl 'https://api.korsou.dev/v1/neighborhoods/nbh_barber/context'
Open in browser ↗
Request and response schemas
{
  "summary": "Neighborhood geography, census and upcoming waste schedules",
  "description": "Get the neighborhood, its geozone, census figures and linked waste schedules. Each section includes its source and availability; missing optional data does not block the response. Census returns up to 100 indicators. Continue with next_cursor on /v1/census_indicators, using the same neighborhood_id and limit=100. Waste returns up to three ongoing or future set-out windows per matched zone, ordered by start date. has_more indicates additional windows. as_of defaults to today in America/Curacao. A place_match links a provider place to the neighborhood, without confirming service for every address. no_match does not rule out service.",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "pattern": "^nbh_[a-z0-9]+(?:_[a-z0-9]+)*$"
      }
    },
    {
      "name": "as_of",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "format": "date"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "$ref": "#/components/schemas/NeighborhoodContext"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Search government address points

GET/v1/addresses

Government of Curaçao / VVRP Basiskaart address points retrieved on 19 October 2026. The source update date is unknown. Coverage is incomplete and postal deliverability is not verified. Postal codes and address-to-neighborhood relationships are not available. Source license: Unknown.

ParameterInRequired
limitqueryOptional
cursorqueryOptional
qqueryOptional
street_idqueryOptional
house_numberqueryOptional
curl 'https://api.korsou.dev/v1/addresses'
Open in browser ↗
Request and response schemas
{
  "summary": "Search government address points",
  "description": "Government of Curaçao / VVRP Basiskaart address points retrieved on 19 October 2026. The source update date is unknown. Coverage is incomplete and postal deliverability is not verified. Postal codes and address-to-neighborhood relationships are not available. Source license: Unknown.",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 50
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      }
    },
    {
      "name": "q",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 120
      }
    },
    {
      "name": "street_id",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^str_[a-f0-9]{24}$"
      }
    },
    {
      "name": "house_number",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 40
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Address"
                }
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  },
                  "pagination": {
                    "type": "object",
                    "properties": {
                      "limit": {
                        "type": "integer"
                      },
                      "cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "next_cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "limit",
                      "cursor",
                      "next_cursor"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version",
                  "pagination"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Look up a permanent address ID

GET/v1/addresses/{id}

Government of Curaçao / VVRP Basiskaart address points retrieved on 19 October 2026. The source update date is unknown. Coverage is incomplete and postal deliverability is not verified. Postal codes and address-to-neighborhood relationships are not available. Source license: Unknown.

ParameterInRequired
idpathRequired
curl 'https://api.korsou.dev/v1/addresses/adr_07178bc49c36ec375ac1f455'
Open in browser ↗
Request and response schemas
{
  "summary": "Look up a permanent address ID",
  "description": "Government of Curaçao / VVRP Basiskaart address points retrieved on 19 October 2026. The source update date is unknown. Coverage is incomplete and postal deliverability is not verified. Postal codes and address-to-neighborhood relationships are not available. Source license: Unknown.",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "pattern": "^adr_[a-f0-9]{24}$"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "$ref": "#/components/schemas/Address"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Search names used by address points

GET/v1/streets

Government of Curaçao / VVRP Basiskaart address points retrieved on 19 October 2026. The source update date is unknown. Coverage is incomplete and postal deliverability is not verified. Postal codes and address-to-neighborhood relationships are not available. Source license: Unknown. Street records group address names, which can also refer to areas. They do not describe physical road segments.

ParameterInRequired
limitqueryOptional
cursorqueryOptional
qqueryOptional
curl 'https://api.korsou.dev/v1/streets'
Open in browser ↗
Request and response schemas
{
  "summary": "Search names used by address points",
  "description": "Government of Curaçao / VVRP Basiskaart address points retrieved on 19 October 2026. The source update date is unknown. Coverage is incomplete and postal deliverability is not verified. Postal codes and address-to-neighborhood relationships are not available. Source license: Unknown. Street records group address names, which can also refer to areas. They do not describe physical road segments.",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 50
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      }
    },
    {
      "name": "q",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 120
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Street"
                }
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  },
                  "pagination": {
                    "type": "object",
                    "properties": {
                      "limit": {
                        "type": "integer"
                      },
                      "cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "next_cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "limit",
                      "cursor",
                      "next_cursor"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version",
                  "pagination"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Look up a permanent street-name ID

GET/v1/streets/{id}

Government of Curaçao / VVRP Basiskaart address points retrieved on 19 October 2026. The source update date is unknown. Coverage is incomplete and postal deliverability is not verified. Postal codes and address-to-neighborhood relationships are not available. Source license: Unknown.

ParameterInRequired
idpathRequired
curl 'https://api.korsou.dev/v1/streets/str_90da81a98969b134a6a9cb25'
Open in browser ↗
Request and response schemas
{
  "summary": "Look up a permanent street-name ID",
  "description": "Government of Curaçao / VVRP Basiskaart address points retrieved on 19 October 2026. The source update date is unknown. Coverage is incomplete and postal deliverability is not verified. Postal codes and address-to-neighborhood relationships are not available. Source license: Unknown.",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "pattern": "^str_[a-f0-9]{24}$"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "$ref": "#/components/schemas/Street"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Curaçao addressing profile

GET/v1/addressing/profile

Country addressing facts for checkout and CRM forms. country_code is CW. Curaçao has no national postcodes, so has_postal_codes and postal_code_required are false. Use a neighborhood ID as the locality.

curl 'https://api.korsou.dev/v1/addressing/profile'
Open in browser ↗
Request and response schemas
{
  "summary": "Curaçao addressing profile",
  "description": "Country addressing facts for checkout and CRM forms. country_code is CW. Curaçao has no national postcodes, so has_postal_codes and postal_code_required are false. Use a neighborhood ID as the locality.",
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "$ref": "#/components/schemas/AddressingProfile"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Resolve neighborhoods as localities

GET/v1/localities

Neighborhood records shaped for address forms. IDs are the existing nbh_* identities. Search with q or filter by geozone_id. This is not a postcode directory.

ParameterInRequired
limitqueryOptional
cursorqueryOptional
qqueryOptional
geozone_idqueryOptional
curl 'https://api.korsou.dev/v1/localities?q=abrahamsz'
Open in browser ↗
Request and response schemas
{
  "summary": "Resolve neighborhoods as localities",
  "description": "Neighborhood records shaped for address forms. IDs are the existing nbh_* identities. Search with q or filter by geozone_id. This is not a postcode directory.",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 50
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      }
    },
    {
      "name": "q",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 120
      }
    },
    {
      "name": "geozone_id",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^gz_[a-z0-9]+(?:_[a-z0-9]+)*$"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Locality"
                }
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  },
                  "pagination": {
                    "type": "object",
                    "properties": {
                      "limit": {
                        "type": "integer"
                      },
                      "cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "next_cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "limit",
                      "cursor",
                      "next_cursor"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version",
                  "pagination"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Suggest localities, streets and addresses

GET/v1/addressing/suggest

Autocomplete against published neighborhoods and government address points. q is required. Results are ready to render. Street and address matches are omitted when those collections are unavailable. This is not a postcode lookup.

ParameterInRequired
limitqueryOptional
cursorqueryOptional
qqueryRequired
curl 'https://api.korsou.dev/v1/addressing/suggest?q=abrahamsz'
Open in browser ↗
Request and response schemas
{
  "summary": "Suggest localities, streets and addresses",
  "description": "Autocomplete against published neighborhoods and government address points. q is required. Results are ready to render. Street and address matches are omitted when those collections are unavailable. This is not a postcode lookup.",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 50
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      }
    },
    {
      "name": "q",
      "in": "query",
      "required": true,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 120
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/AddressSuggestion"
                }
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  },
                  "pagination": {
                    "type": "object",
                    "properties": {
                      "limit": {
                        "type": "integer"
                      },
                      "cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "next_cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "limit",
                      "cursor",
                      "next_cursor"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version",
                  "pagination"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Company search (not yet available)

GET/v1/businesses

The business API has not launched. Search requires q. Valid requests return 503 dataset_unavailable.

ParameterInRequired
limitqueryOptional
cursorqueryOptional
qqueryRequired
curl 'https://api.korsou.dev/v1/businesses?q=company'
Open in browser ↗
Request and response schemas
{
  "summary": "Company search (not yet available)",
  "description": "The business API has not launched. Search requires q. Valid requests return 503 dataset_unavailable.",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 20
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      }
    },
    {
      "name": "q",
      "in": "query",
      "required": true,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 120
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Business"
                }
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  },
                  "pagination": {
                    "type": "object",
                    "properties": {
                      "limit": {
                        "type": "integer"
                      },
                      "cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "next_cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "limit",
                      "cursor",
                      "next_cursor"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version",
                  "pagination"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Company lookup by registry number (not yet available)

GET/v1/businesses/{registryNumber}

The business API has not launched. Valid requests return 503 dataset_unavailable. An API result is not an official Chamber excerpt.

ParameterInRequired
registryNumberpathRequired
curl 'https://api.korsou.dev/v1/businesses/123456'
Open in browser ↗
Request and response schemas
{
  "summary": "Company lookup by registry number (not yet available)",
  "description": "The business API has not launched. Valid requests return 503 dataset_unavailable. An API result is not an official Chamber excerpt.",
  "parameters": [
    {
      "name": "registryNumber",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "pattern": "^[0-9]{1,20}$"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "$ref": "#/components/schemas/Business"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

School vacation dates

GET/v1/school_vacations

Vacation ranges from government school rosters. Start and end dates are inclusive. These are school vacations, not public holidays; they are separate from /v1/holidays.

ParameterInRequired
limitqueryOptional
cursorqueryOptional
school_yearqueryOptional
curl 'https://api.korsou.dev/v1/school_vacations'
Open in browser ↗
Request and response schemas
{
  "summary": "School vacation dates",
  "description": "Vacation ranges from government school rosters. Start and end dates are inclusive. These are school vacations, not public holidays; they are separate from /v1/holidays.",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 50
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      }
    },
    {
      "name": "school_year",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^\\d{4}-\\d{4}$"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/SchoolVacation"
                }
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  },
                  "pagination": {
                    "type": "object",
                    "properties": {
                      "limit": {
                        "type": "integer"
                      },
                      "cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "next_cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "limit",
                      "cursor",
                      "next_cursor"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version",
                  "pagination"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Fuel, electricity and water tariffs

GET/v1/tariffs

Fuel, electricity and water prices from government advertisements and ministerial decrees. Amounts retain the printed currency. The API does not convert NAF, NAf, CMg or Cg.

ParameterInRequired
limitqueryOptional
cursorqueryOptional
productqueryOptional
fromqueryOptional
toqueryOptional
curl 'https://api.korsou.dev/v1/tariffs'
Open in browser ↗
Request and response schemas
{
  "summary": "Fuel, electricity and water tariffs",
  "description": "Fuel, electricity and water prices from government advertisements and ministerial decrees. Amounts retain the printed currency. The API does not convert NAF, NAf, CMg or Cg.",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 50
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      }
    },
    {
      "name": "product",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-z][a-z0-9_]*$"
      }
    },
    {
      "name": "from",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "format": "date"
      }
    },
    {
      "name": "to",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "format": "date"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/TariffObservation"
                }
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  },
                  "pagination": {
                    "type": "object",
                    "properties": {
                      "limit": {
                        "type": "integer"
                      },
                      "cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "next_cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "limit",
                      "cursor",
                      "next_cursor"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version",
                  "pagination"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Census 2023 indicators by neighborhood or geozone

GET/v1/census_indicators

Census theme-table indicators with gz_* geozone and nbh_* neighborhood IDs. Filter by geography, table or indicator. Coverage varies by table. Cite CBS when using these figures.

ParameterInRequired
limitqueryOptional
cursorqueryOptional
geozone_idqueryOptional
neighborhood_idqueryOptional
tablequeryOptional
indicatorqueryOptional
curl 'https://api.korsou.dev/v1/census_indicators'
Open in browser ↗
Request and response schemas
{
  "summary": "Census 2023 indicators by neighborhood or geozone",
  "description": "Census theme-table indicators with gz_* geozone and nbh_* neighborhood IDs. Filter by geography, table or indicator. Coverage varies by table. Cite CBS when using these figures.",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 50
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      }
    },
    {
      "name": "geozone_id",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^gz_[a-z0-9]+(?:_[a-z0-9]+)*$"
      }
    },
    {
      "name": "neighborhood_id",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^nbh_[a-z0-9]+(?:_[a-z0-9]+)*$"
      }
    },
    {
      "name": "table",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "enum": [
          "G-1",
          "G-2",
          "G-3",
          "G-4",
          "G-5"
        ]
      }
    },
    {
      "name": "indicator",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-z][a-z0-9_]*$"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/CensusIndicator"
                }
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  },
                  "pagination": {
                    "type": "object",
                    "properties": {
                      "limit": {
                        "type": "integer"
                      },
                      "cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "next_cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "limit",
                      "cursor",
                      "next_cursor"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version",
                  "pagination"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Monthly visitor arrivals

GET/v1/tourism_arrivals

Monthly stayover, cruise and day-tripper arrival totals from Curaçao Tourist Board publications. Filter by period or metric. Omitting market returns national totals only. Optional market is present only when the source names one. Cite the source when using these figures. Check dataset metadata for availability and reuse terms.

ParameterInRequired
limitqueryOptional
cursorqueryOptional
periodqueryOptional
metricqueryOptional
marketqueryOptional
curl 'https://api.korsou.dev/v1/tourism_arrivals?period=2026-07'
Open in browser ↗
Request and response schemas
{
  "summary": "Monthly visitor arrivals",
  "description": "Monthly stayover, cruise and day-tripper arrival totals from Curaçao Tourist Board publications. Filter by period or metric. Omitting market returns national totals only. Optional market is present only when the source names one. Cite the source when using these figures. Check dataset metadata for availability and reuse terms.",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 50
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      }
    },
    {
      "name": "period",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^\\d{4}-(0[1-9]|1[0-2])$"
      }
    },
    {
      "name": "metric",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "enum": [
          "stayover",
          "cruise",
          "day_trippers"
        ]
      }
    },
    {
      "name": "market",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-z][a-z0-9_]*$"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/TourismArrival"
                }
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  },
                  "pagination": {
                    "type": "object",
                    "properties": {
                      "limit": {
                        "type": "integer"
                      },
                      "cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "next_cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "limit",
                      "cursor",
                      "next_cursor"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version",
                  "pagination"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Minimum wage, poverty line and contribution ceilings

GET/v1/statutory_rates

Statutory rate observations identified by code and effective_from, with source-defined applicability. Amounts stay in the printed currency. Filter by code, kind, household composition or date. These records are not a government document or a payroll calculation. Check dataset metadata for availability and reuse terms.

ParameterInRequired
limitqueryOptional
cursorqueryOptional
codequeryOptional
kindqueryOptional
adultsqueryOptional
childrenqueryOptional
fromqueryOptional
toqueryOptional
curl 'https://api.korsou.dev/v1/statutory_rates?kind=poverty_line'
Open in browser ↗
Request and response schemas
{
  "summary": "Minimum wage, poverty line and contribution ceilings",
  "description": "Statutory rate observations identified by code and effective_from, with source-defined applicability. Amounts stay in the printed currency. Filter by code, kind, household composition or date. These records are not a government document or a payroll calculation. Check dataset metadata for availability and reuse terms.",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 50
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      }
    },
    {
      "name": "code",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-z][a-z0-9_]*$"
      }
    },
    {
      "name": "kind",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "enum": [
          "min_wage",
          "poverty_line",
          "contribution_ceiling"
        ]
      }
    },
    {
      "name": "adults",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "exclusiveMinimum": 0
      }
    },
    {
      "name": "children",
      "in": "query",
      "required": false,
      "schema": {
        "type": [
          "integer",
          "null"
        ],
        "minimum": 0
      }
    },
    {
      "name": "from",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "format": "date"
      }
    },
    {
      "name": "to",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "format": "date"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/StatutoryRate"
                }
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  },
                  "pagination": {
                    "type": "object",
                    "properties": {
                      "limit": {
                        "type": "integer"
                      },
                      "cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "next_cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "limit",
                      "cursor",
                      "next_cursor"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version",
                  "pagination"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Official exchange rates for commercial banks

GET/v1/official_exchange_rates

Working-day rates from the Centrale Bank van Curaçao en Sint Maarten for use by commercial banks. Each row is one published currency on one rate date, with buy notes, buy cheques/transfers and sell as printed. A second selling rate appears as sell_cheques when the bank prints one. Filter by currency, from or to. Weekends and bank holidays are omitted when the bank did not publish a row. These records are not a bank quote or a conversion service. Check dataset metadata for availability and reuse terms.

ParameterInRequired
limitqueryOptional
cursorqueryOptional
currencyqueryOptional
fromqueryOptional
toqueryOptional
curl 'https://api.korsou.dev/v1/official_exchange_rates'
Open in browser ↗
Request and response schemas
{
  "summary": "Official exchange rates for commercial banks",
  "description": "Working-day rates from the Centrale Bank van Curaçao en Sint Maarten for use by commercial banks. Each row is one published currency on one rate date, with buy notes, buy cheques/transfers and sell as printed. A second selling rate appears as sell_cheques when the bank prints one. Filter by currency, from or to. Weekends and bank holidays are omitted when the bank did not publish a row. These records are not a bank quote or a conversion service. Check dataset metadata for availability and reuse terms.",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 50
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      }
    },
    {
      "name": "currency",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-z][a-z0-9_]*$"
      }
    },
    {
      "name": "from",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "format": "date"
      }
    },
    {
      "name": "to",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "format": "date"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/OfficialExchangeRate"
                }
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  },
                  "pagination": {
                    "type": "object",
                    "properties": {
                      "limit": {
                        "type": "integer"
                      },
                      "cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "next_cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "limit",
                      "cursor",
                      "next_cursor"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version",
                  "pagination"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Monthly CPI by CBS expenditure category

GET/v1/cpi

Monthly consumer price indices from CBS publications, based on average 2023 = 100. Overall CPI (category_code=total) covers January 2024 through August 2026. Detail for 47 CBS expenditure categories, including TOTAL, covers January 2025 through August 2026. The 2024 rows omit monthly_change_percent and weight_2016 because the source table does not report them. monthly_change_percent measures change from the previous month; it is not the inflation rate based on 12-month averages. Category codes are slugs of CBS Household Expenditure Survey 2016 labels, not UN COICOP codes. Cite CBS when using these figures.

ParameterInRequired
limitqueryOptional
cursorqueryOptional
periodqueryOptional
category_codequeryOptional
curl 'https://api.korsou.dev/v1/cpi'
Open in browser ↗
Request and response schemas
{
  "summary": "Monthly CPI by CBS expenditure category",
  "description": "Monthly consumer price indices from CBS publications, based on average 2023 = 100. Overall CPI (category_code=total) covers January 2024 through August 2026. Detail for 47 CBS expenditure categories, including TOTAL, covers January 2025 through August 2026. The 2024 rows omit monthly_change_percent and weight_2016 because the source table does not report them. monthly_change_percent measures change from the previous month; it is not the inflation rate based on 12-month averages. Category codes are slugs of CBS Household Expenditure Survey 2016 labels, not UN COICOP codes. Cite CBS when using these figures.",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 50
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      }
    },
    {
      "name": "period",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^\\d{4}-(0[1-9]|1[0-2])$"
      }
    },
    {
      "name": "category_code",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-z][a-z0-9_]*$"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/CpiObservation"
                }
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  },
                  "pagination": {
                    "type": "object",
                    "properties": {
                      "limit": {
                        "type": "integer"
                      },
                      "cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "next_cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "limit",
                      "cursor",
                      "next_cursor"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version",
                  "pagination"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Waste collection zones

GET/v1/waste_zones

Selikor service areas, separate from address records and CBS geography. covered_neighborhood_ids lists neighborhoods served in full; the list may be incomplete. A neighborhood filter without known whole-neighborhood coverage returns 503. Check dataset metadata for availability and reuse terms.

ParameterInRequired
limitqueryOptional
cursorqueryOptional
place_idqueryOptional
neighborhood_idqueryOptional
servicequeryOptional
curl 'https://api.korsou.dev/v1/waste_zones'
Open in browser ↗
Request and response schemas
{
  "summary": "Waste collection zones",
  "description": "Selikor service areas, separate from address records and CBS geography. covered_neighborhood_ids lists neighborhoods served in full; the list may be incomplete. A neighborhood filter without known whole-neighborhood coverage returns 503. Check dataset metadata for availability and reuse terms.",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 50
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      }
    },
    {
      "name": "place_id",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^wp_[a-z0-9_]+$"
      }
    },
    {
      "name": "neighborhood_id",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^nbh_[a-z0-9]+(?:_[a-z0-9]+)*$"
      }
    },
    {
      "name": "service",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "enum": [
          "bulky_waste",
          "household_waste"
        ]
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/WasteZone"
                }
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  },
                  "pagination": {
                    "type": "object",
                    "properties": {
                      "limit": {
                        "type": "integer"
                      },
                      "cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "next_cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "limit",
                      "cursor",
                      "next_cursor"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version",
                  "pagination"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Waste set-out dates by zone or neighborhood

GET/v1/waste_collections

Selikor dates in America/Curacao. from/to select set-out windows that overlap the inclusive date range. Set-out dates tell residents when to put waste outside; they are not pickup dates. collection_window is omitted when unknown. An empty result means no published dates match the query; collection may still take place. Unsupported neighborhood coverage returns 503. Address lookup is unavailable. Check dataset metadata for availability and reuse terms.

ParameterInRequired
limitqueryOptional
cursorqueryOptional
place_idqueryOptional
neighborhood_idqueryOptional
servicequeryOptional
zone_idqueryOptional
fromqueryOptional
toqueryOptional
curl 'https://api.korsou.dev/v1/waste_collections'
Open in browser ↗
Request and response schemas
{
  "summary": "Waste set-out dates by zone or neighborhood",
  "description": "Selikor dates in America/Curacao. from/to select set-out windows that overlap the inclusive date range. Set-out dates tell residents when to put waste outside; they are not pickup dates. collection_window is omitted when unknown. An empty result means no published dates match the query; collection may still take place. Unsupported neighborhood coverage returns 503. Address lookup is unavailable. Check dataset metadata for availability and reuse terms.",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 50
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048
      }
    },
    {
      "name": "place_id",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^wp_[a-z0-9_]+$"
      }
    },
    {
      "name": "neighborhood_id",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^nbh_[a-z0-9]+(?:_[a-z0-9]+)*$"
      }
    },
    {
      "name": "service",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "enum": [
          "bulky_waste",
          "household_waste"
        ]
      }
    },
    {
      "name": "zone_id",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^wz_[a-z0-9_]+$"
      }
    },
    {
      "name": "from",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "format": "date"
      }
    },
    {
      "name": "to",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "format": "date"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/WasteCollection"
                }
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  },
                  "pagination": {
                    "type": "object",
                    "properties": {
                      "limit": {
                        "type": "integer"
                      },
                      "cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "next_cursor": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "limit",
                      "cursor",
                      "next_cursor"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version",
                  "pagination"
                ]
              }
            },
            "required": [
              "data",
              "meta"
            ]
          }
        }
      }
    },
    "304": {
      "description": "Not modified"
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; retry after 60 seconds",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Internal error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    },
    "503": {
      "description": "Dataset is not available",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "enum": [
                      "invalid_request",
                      "invalid_parameter",
                      "not_found",
                      "rate_limited",
                      "upstream_unavailable",
                      "dataset_unavailable",
                      "internal_error"
                    ]
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "code",
                  "message"
                ]
              },
              "meta": {
                "type": "object",
                "properties": {
                  "request_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "api_version": {
                    "type": "string",
                    "enum": [
                      "v1"
                    ]
                  }
                },
                "required": [
                  "request_id",
                  "api_version"
                ]
              }
            },
            "required": [
              "error",
              "meta"
            ]
          }
        }
      }
    }
  }
}

Response schemas

The v1 schema is separate from each record's dataset_version. Required array fields contain arrays, including when empty. Unavailable optional fields are omitted. Zero is a valid value. Text fields are ready to display. IDs remain stable across spelling changes. Breaking field or type changes require a new API version.

Holiday
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^[a-z][a-z0-9-]*$"
    },
    "date": {
      "type": "string",
      "format": "date"
    },
    "names": {
      "type": "object",
      "properties": {
        "pap": {
          "type": "string",
          "minLength": 1
        },
        "nl": {
          "type": "string",
          "minLength": 1
        },
        "en": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "nl"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "public_holiday",
        "partial_public_holiday"
      ]
    },
    "all_day": {
      "type": "boolean"
    },
    "fixed_date": {
      "type": "boolean"
    },
    "observed_date": {
      "type": "string",
      "format": "date"
    },
    "notes": {
      "type": "string"
    },
    "provenance": {
      "$ref": "#/components/schemas/Provenance"
    }
  },
  "required": [
    "id",
    "date",
    "names",
    "type",
    "all_day",
    "fixed_date",
    "provenance"
  ]
}
Provenance
{
  "type": "object",
  "properties": {
    "source": {
      "type": "string",
      "minLength": 1
    },
    "source_url": {
      "type": "string",
      "format": "uri"
    },
    "retrieved_at": {
      "type": "string",
      "format": "date-time"
    },
    "source_updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "dataset_version": {
      "type": "string",
      "minLength": 1
    },
    "license": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "source",
    "source_url",
    "retrieved_at",
    "dataset_version"
  ]
}
Geozone
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^gz_[a-z0-9]+(?:_[a-z0-9]+)*$"
    },
    "name": {
      "type": "string"
    },
    "aliases": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "country_code": {
      "type": "string",
      "enum": [
        "CW"
      ]
    },
    "centroid": {
      "type": "object",
      "properties": {
        "latitude": {
          "type": "number",
          "minimum": -90,
          "maximum": 90
        },
        "longitude": {
          "type": "number",
          "minimum": -180,
          "maximum": 180
        }
      },
      "required": [
        "latitude",
        "longitude"
      ]
    },
    "geometry_available": {
      "type": "boolean"
    },
    "provenance": {
      "$ref": "#/components/schemas/Provenance"
    }
  },
  "required": [
    "id",
    "name",
    "aliases",
    "country_code",
    "geometry_available",
    "provenance"
  ]
}
Neighborhood
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^nbh_[a-z0-9]+(?:_[a-z0-9]+)*$"
    },
    "name": {
      "type": "string"
    },
    "aliases": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "country_code": {
      "type": "string",
      "enum": [
        "CW"
      ]
    },
    "centroid": {
      "type": "object",
      "properties": {
        "latitude": {
          "type": "number",
          "minimum": -90,
          "maximum": 90
        },
        "longitude": {
          "type": "number",
          "minimum": -180,
          "maximum": 180
        }
      },
      "required": [
        "latitude",
        "longitude"
      ]
    },
    "geometry_available": {
      "type": "boolean"
    },
    "provenance": {
      "$ref": "#/components/schemas/Provenance"
    },
    "geozone_id": {
      "type": "string",
      "pattern": "^gz_[a-z0-9]+(?:_[a-z0-9]+)*$"
    },
    "population": {
      "type": "object",
      "properties": {
        "census_year": {
          "type": "integer"
        },
        "total": {
          "type": "integer",
          "minimum": 0
        }
      },
      "required": [
        "census_year",
        "total"
      ]
    }
  },
  "required": [
    "id",
    "name",
    "aliases",
    "country_code",
    "geometry_available",
    "provenance",
    "geozone_id"
  ]
}
NeighborhoodContext
{
  "type": "object",
  "properties": {
    "as_of": {
      "type": "string",
      "format": "date"
    },
    "neighborhood": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "pattern": "^nbh_[a-z0-9]+(?:_[a-z0-9]+)*$"
        },
        "name": {
          "type": "string"
        },
        "aliases": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "country_code": {
          "type": "string",
          "enum": [
            "CW"
          ]
        },
        "centroid": {
          "type": "object",
          "properties": {
            "latitude": {
              "type": "number",
              "minimum": -90,
              "maximum": 90
            },
            "longitude": {
              "type": "number",
              "minimum": -180,
              "maximum": 180
            }
          },
          "required": [
            "latitude",
            "longitude"
          ]
        },
        "geometry_available": {
          "type": "boolean"
        },
        "provenance": {
          "type": "object",
          "properties": {
            "source": {
              "type": "string",
              "minLength": 1
            },
            "source_url": {
              "type": "string",
              "format": "uri"
            },
            "retrieved_at": {
              "type": "string",
              "format": "date-time"
            },
            "source_updated_at": {
              "type": "string",
              "format": "date-time"
            },
            "dataset_version": {
              "type": "string",
              "minLength": 1
            },
            "license": {
              "type": "string",
              "minLength": 1
            }
          },
          "required": [
            "source",
            "source_url",
            "retrieved_at",
            "dataset_version"
          ]
        },
        "geozone_id": {
          "type": "string",
          "pattern": "^gz_[a-z0-9]+(?:_[a-z0-9]+)*$"
        },
        "population": {
          "type": "object",
          "properties": {
            "census_year": {
              "type": "integer"
            },
            "total": {
              "type": "integer",
              "minimum": 0
            }
          },
          "required": [
            "census_year",
            "total"
          ]
        }
      },
      "required": [
        "id",
        "name",
        "aliases",
        "country_code",
        "geometry_available",
        "provenance",
        "geozone_id"
      ]
    },
    "geozone": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "available",
            "no_data",
            "unavailable"
          ]
        },
        "record": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "id": {
              "type": "string",
              "pattern": "^gz_[a-z0-9]+(?:_[a-z0-9]+)*$"
            },
            "name": {
              "type": "string"
            },
            "aliases": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "country_code": {
              "type": "string",
              "enum": [
                "CW"
              ]
            },
            "centroid": {
              "type": "object",
              "properties": {
                "latitude": {
                  "type": "number",
                  "minimum": -90,
                  "maximum": 90
                },
                "longitude": {
                  "type": "number",
                  "minimum": -180,
                  "maximum": 180
                }
              },
              "required": [
                "latitude",
                "longitude"
              ]
            },
            "geometry_available": {
              "type": "boolean"
            },
            "provenance": {
              "type": "object",
              "properties": {
                "source": {
                  "type": "string",
                  "minLength": 1
                },
                "source_url": {
                  "type": "string",
                  "format": "uri"
                },
                "retrieved_at": {
                  "type": "string",
                  "format": "date-time"
                },
                "source_updated_at": {
                  "type": "string",
                  "format": "date-time"
                },
                "dataset_version": {
                  "type": "string",
                  "minLength": 1
                },
                "license": {
                  "type": "string",
                  "minLength": 1
                }
              },
              "required": [
                "source",
                "source_url",
                "retrieved_at",
                "dataset_version"
              ]
            }
          },
          "required": [
            "id",
            "name",
            "aliases",
            "country_code",
            "geometry_available",
            "provenance"
          ]
        },
        "dataset": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "pattern": "^[a-z][a-z0-9_]{0,79}$"
            },
            "name": {
              "type": "string"
            },
            "status": {
              "type": "string",
              "enum": [
                "available",
                "unavailable"
              ]
            },
            "version": {
              "type": [
                "string",
                "null"
              ]
            },
            "last_updated": {
              "type": [
                "string",
                "null"
              ]
            },
            "record_count": {
              "type": "integer"
            },
            "source": {
              "type": "object",
              "properties": {
                "authority": {
                  "type": "string"
                },
                "url": {
                  "type": "string",
                  "format": "uri"
                },
                "redistribution_status": {
                  "type": "string",
                  "enum": [
                    "permitted",
                    "restricted",
                    "unknown",
                    "internal_only"
                  ]
                },
                "contributors": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "minLength": 1
                      },
                      "authority": {
                        "type": "string",
                        "minLength": 1
                      },
                      "url": {
                        "type": "string",
                        "format": "uri"
                      },
                      "redistribution_status": {
                        "type": "string",
                        "enum": [
                          "permitted",
                          "restricted",
                          "unknown",
                          "internal_only"
                        ]
                      },
                      "license": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "id",
                      "authority",
                      "url",
                      "redistribution_status",
                      "license"
                    ]
                  },
                  "minItems": 2
                }
              },
              "required": [
                "authority",
                "url",
                "redistribution_status"
              ]
            },
            "license": {
              "type": [
                "string",
                "null"
              ]
            },
            "formats": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "json"
                ]
              }
            }
          },
          "required": [
            "id",
            "name",
            "status",
            "version",
            "last_updated",
            "record_count",
            "source",
            "license",
            "formats"
          ]
        }
      },
      "required": [
        "status",
        "record",
        "dataset"
      ]
    },
    "census": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "available",
            "no_data",
            "unavailable"
          ]
        },
        "dataset": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "pattern": "^[a-z][a-z0-9_]{0,79}$"
            },
            "name": {
              "type": "string"
            },
            "status": {
              "type": "string",
              "enum": [
                "available",
                "unavailable"
              ]
            },
            "version": {
              "type": [
                "string",
                "null"
              ]
            },
            "last_updated": {
              "type": [
                "string",
                "null"
              ]
            },
            "record_count": {
              "type": "integer"
            },
            "source": {
              "type": "object",
              "properties": {
                "authority": {
                  "type": "string"
                },
                "url": {
                  "type": "string",
                  "format": "uri"
                },
                "redistribution_status": {
                  "type": "string",
                  "enum": [
                    "permitted",
                    "restricted",
                    "unknown",
                    "internal_only"
                  ]
                },
                "contributors": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "minLength": 1
                      },
                      "authority": {
                        "type": "string",
                        "minLength": 1
                      },
                      "url": {
                        "type": "string",
                        "format": "uri"
                      },
                      "redistribution_status": {
                        "type": "string",
                        "enum": [
                          "permitted",
                          "restricted",
                          "unknown",
                          "internal_only"
                        ]
                      },
                      "license": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "id",
                      "authority",
                      "url",
                      "redistribution_status",
                      "license"
                    ]
                  },
                  "minItems": 2
                }
              },
              "required": [
                "authority",
                "url",
                "redistribution_status"
              ]
            },
            "license": {
              "type": [
                "string",
                "null"
              ]
            },
            "formats": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "json"
                ]
              }
            }
          },
          "required": [
            "id",
            "name",
            "status",
            "version",
            "last_updated",
            "record_count",
            "source",
            "license",
            "formats"
          ]
        },
        "indicators": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "geography_id": {
                "anyOf": [
                  {
                    "type": "string",
                    "pattern": "^gz_[a-z0-9]+(?:_[a-z0-9]+)*$"
                  },
                  {
                    "type": "string",
                    "pattern": "^nbh_[a-z0-9]+(?:_[a-z0-9]+)*$"
                  }
                ]
              },
              "geography_type": {
                "type": "string",
                "enum": [
                  "geozone",
                  "neighborhood"
                ]
              },
              "geozone_id": {
                "type": "string",
                "pattern": "^gz_[a-z0-9]+(?:_[a-z0-9]+)*$"
              },
              "indicator": {
                "type": "string"
              },
              "census_year": {
                "type": "number",
                "enum": [
                  2023
                ]
              },
              "value": {
                "type": "number"
              },
              "unit": {
                "type": "string",
                "enum": [
                  "count",
                  "persons_per_household"
                ]
              },
              "table": {
                "type": "string",
                "enum": [
                  "G-1",
                  "G-2",
                  "G-3",
                  "G-4",
                  "G-5"
                ]
              },
              "provenance": {
                "type": "object",
                "properties": {
                  "source": {
                    "type": "string",
                    "minLength": 1
                  },
                  "source_url": {
                    "type": "string",
                    "format": "uri"
                  },
                  "retrieved_at": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "source_updated_at": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "dataset_version": {
                    "type": "string",
                    "minLength": 1
                  },
                  "license": {
                    "type": "string",
                    "minLength": 1
                  }
                },
                "required": [
                  "source",
                  "source_url",
                  "retrieved_at",
                  "dataset_version"
                ]
              }
            },
            "required": [
              "id",
              "geography_id",
              "geography_type",
              "indicator",
              "census_year",
              "value",
              "unit",
              "table",
              "provenance"
            ]
          },
          "maxItems": 100
        },
        "limit": {
          "type": "number",
          "enum": [
            100
          ]
        },
        "next_cursor": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "status",
        "dataset",
        "indicators",
        "limit",
        "next_cursor"
      ]
    },
    "waste": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "available",
            "no_match",
            "unavailable"
          ]
        },
        "zones_dataset": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "pattern": "^[a-z][a-z0-9_]{0,79}$"
            },
            "name": {
              "type": "string"
            },
            "status": {
              "type": "string",
              "enum": [
                "available",
                "unavailable"
              ]
            },
            "version": {
              "type": [
                "string",
                "null"
              ]
            },
            "last_updated": {
              "type": [
                "string",
                "null"
              ]
            },
            "record_count": {
              "type": "integer"
            },
            "source": {
              "type": "object",
              "properties": {
                "authority": {
                  "type": "string"
                },
                "url": {
                  "type": "string",
                  "format": "uri"
                },
                "redistribution_status": {
                  "type": "string",
                  "enum": [
                    "permitted",
                    "restricted",
                    "unknown",
                    "internal_only"
                  ]
                },
                "contributors": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "minLength": 1
                      },
                      "authority": {
                        "type": "string",
                        "minLength": 1
                      },
                      "url": {
                        "type": "string",
                        "format": "uri"
                      },
                      "redistribution_status": {
                        "type": "string",
                        "enum": [
                          "permitted",
                          "restricted",
                          "unknown",
                          "internal_only"
                        ]
                      },
                      "license": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "id",
                      "authority",
                      "url",
                      "redistribution_status",
                      "license"
                    ]
                  },
                  "minItems": 2
                }
              },
              "required": [
                "authority",
                "url",
                "redistribution_status"
              ]
            },
            "license": {
              "type": [
                "string",
                "null"
              ]
            },
            "formats": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "json"
                ]
              }
            }
          },
          "required": [
            "id",
            "name",
            "status",
            "version",
            "last_updated",
            "record_count",
            "source",
            "license",
            "formats"
          ]
        },
        "collections_dataset": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "pattern": "^[a-z][a-z0-9_]{0,79}$"
            },
            "name": {
              "type": "string"
            },
            "status": {
              "type": "string",
              "enum": [
                "available",
                "unavailable"
              ]
            },
            "version": {
              "type": [
                "string",
                "null"
              ]
            },
            "last_updated": {
              "type": [
                "string",
                "null"
              ]
            },
            "record_count": {
              "type": "integer"
            },
            "source": {
              "type": "object",
              "properties": {
                "authority": {
                  "type": "string"
                },
                "url": {
                  "type": "string",
                  "format": "uri"
                },
                "redistribution_status": {
                  "type": "string",
                  "enum": [
                    "permitted",
                    "restricted",
                    "unknown",
                    "internal_only"
                  ]
                },
                "contributors": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "minLength": 1
                      },
                      "authority": {
                        "type": "string",
                        "minLength": 1
                      },
                      "url": {
                        "type": "string",
                        "format": "uri"
                      },
                      "redistribution_status": {
                        "type": "string",
                        "enum": [
                          "permitted",
                          "restricted",
                          "unknown",
                          "internal_only"
                        ]
                      },
                      "license": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "id",
                      "authority",
                      "url",
                      "redistribution_status",
                      "license"
                    ]
                  },
                  "minItems": 2
                }
              },
              "required": [
                "authority",
                "url",
                "redistribution_status"
              ]
            },
            "license": {
              "type": [
                "string",
                "null"
              ]
            },
            "formats": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "json"
                ]
              }
            }
          },
          "required": [
            "id",
            "name",
            "status",
            "version",
            "last_updated",
            "record_count",
            "source",
            "license",
            "formats"
          ]
        },
        "collections_status": {
          "type": "string",
          "enum": [
            "available",
            "unavailable"
          ]
        },
        "upcoming_limit_per_zone": {
          "type": "number",
          "enum": [
            3
          ]
        },
        "matches": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "zone": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^wz_[a-z0-9_]+$"
                  },
                  "name": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 200
                  },
                  "provider_id": {
                    "type": "string",
                    "pattern": "^[a-z][a-z0-9_]*$"
                  },
                  "provider_name": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 200
                  },
                  "service": {
                    "type": "string",
                    "enum": [
                      "bulky_waste",
                      "household_waste"
                    ]
                  }
                },
                "required": [
                  "id",
                  "name",
                  "provider_id",
                  "provider_name",
                  "service"
                ]
              },
              "relationship": {
                "type": "string",
                "enum": [
                  "place_match",
                  "neighborhood_coverage"
                ]
              },
              "places": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "pattern": "^wp_[a-z0-9_]+$"
                    },
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 200
                    },
                    "neighborhood_id": {
                      "type": "string",
                      "pattern": "^nbh_[a-z0-9]+(?:_[a-z0-9]+)*$"
                    }
                  },
                  "required": [
                    "id",
                    "name"
                  ]
                }
              },
              "upcoming_collections": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "pattern": "^wc_[a-z0-9_]+$"
                    },
                    "zone_id": {
                      "type": "string",
                      "pattern": "^wz_[a-z0-9_]+$"
                    },
                    "set_out_window": {
                      "type": "object",
                      "properties": {
                        "start_date": {
                          "type": "string",
                          "format": "date"
                        },
                        "end_date": {
                          "type": "string",
                          "format": "date"
                        }
                      },
                      "required": [
                        "start_date",
                        "end_date"
                      ]
                    },
                    "collection_window": {
                      "type": "object",
                      "properties": {
                        "start_date": {
                          "type": "string",
                          "format": "date"
                        },
                        "end_date": {
                          "type": "string",
                          "format": "date"
                        }
                      },
                      "required": [
                        "start_date",
                        "end_date"
                      ]
                    },
                    "instructions": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    "provenance": {
                      "type": "object",
                      "properties": {
                        "source": {
                          "type": "string",
                          "minLength": 1
                        },
                        "source_url": {
                          "type": "string",
                          "format": "uri"
                        },
                        "retrieved_at": {
                          "type": "string",
                          "format": "date-time"
                        },
                        "source_updated_at": {
                          "type": "string",
                          "format": "date-time"
                        },
                        "dataset_version": {
                          "type": "string",
                          "minLength": 1
                        },
                        "license": {
                          "type": "string",
                          "minLength": 1
                        }
                      },
                      "required": [
                        "source",
                        "source_url",
                        "retrieved_at",
                        "dataset_version"
                      ]
                    }
                  },
                  "required": [
                    "id",
                    "zone_id",
                    "set_out_window",
                    "instructions",
                    "provenance"
                  ]
                },
                "maxItems": 3
              },
              "has_more": {
                "type": "boolean"
              }
            },
            "required": [
              "zone",
              "relationship",
              "places",
              "upcoming_collections",
              "has_more"
            ]
          },
          "maxItems": 100
        }
      },
      "required": [
        "status",
        "zones_dataset",
        "collections_dataset",
        "collections_status",
        "upcoming_limit_per_zone",
        "matches"
      ]
    }
  },
  "required": [
    "as_of",
    "neighborhood",
    "geozone",
    "census",
    "waste"
  ]
}
Address
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^adr_[a-f0-9]{24}$"
    },
    "street_id": {
      "type": "string",
      "pattern": "^str_[a-f0-9]{24}$"
    },
    "street_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "house_number": {
      "type": "string",
      "minLength": 1,
      "maxLength": 40
    },
    "formatted_address": {
      "type": "string",
      "minLength": 1,
      "maxLength": 260
    },
    "country_code": {
      "type": "string",
      "enum": [
        "CW"
      ]
    },
    "coordinate": {
      "type": "object",
      "properties": {
        "latitude": {
          "type": "number",
          "minimum": -90,
          "maximum": 90
        },
        "longitude": {
          "type": "number",
          "minimum": -180,
          "maximum": 180
        }
      },
      "required": [
        "latitude",
        "longitude"
      ]
    },
    "provenance": {
      "$ref": "#/components/schemas/Provenance"
    }
  },
  "required": [
    "id",
    "street_id",
    "street_name",
    "house_number",
    "formatted_address",
    "country_code",
    "coordinate",
    "provenance"
  ]
}
Street
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^str_[a-f0-9]{24}$"
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "aliases": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      }
    },
    "country_code": {
      "type": "string",
      "enum": [
        "CW"
      ]
    },
    "provenance": {
      "$ref": "#/components/schemas/Provenance"
    }
  },
  "required": [
    "id",
    "name",
    "aliases",
    "country_code",
    "provenance"
  ]
}
AddressingProfile
{
  "type": "object",
  "properties": {
    "country_code": {
      "type": "string",
      "enum": [
        "CW"
      ]
    },
    "country_name": {
      "type": "string",
      "enum": [
        "Curaçao"
      ]
    },
    "has_postal_codes": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "postal_code_required": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "locality_kind": {
      "type": "string",
      "enum": [
        "neighborhood"
      ]
    },
    "recommended_form_fields": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "street_name",
          "house_number",
          "locality_id"
        ]
      }
    },
    "notes": {
      "type": "string"
    }
  },
  "required": [
    "country_code",
    "country_name",
    "has_postal_codes",
    "postal_code_required",
    "locality_kind",
    "recommended_form_fields",
    "notes"
  ]
}
Locality
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^nbh_[a-z0-9]+(?:_[a-z0-9]+)*$"
    },
    "name": {
      "type": "string"
    },
    "kind": {
      "type": "string",
      "enum": [
        "neighborhood"
      ]
    },
    "geozone_id": {
      "type": "string",
      "pattern": "^gz_[a-z0-9]+(?:_[a-z0-9]+)*$"
    },
    "aliases": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "id",
    "name",
    "kind",
    "geozone_id",
    "aliases"
  ]
}
AddressSuggestion
{
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "locality",
        "street",
        "address"
      ]
    },
    "id": {
      "type": "string"
    },
    "label": {
      "type": "string"
    },
    "locality_id": {
      "type": "string",
      "pattern": "^nbh_[a-z0-9]+(?:_[a-z0-9]+)*$"
    },
    "street_id": {
      "type": "string"
    },
    "house_number": {
      "type": "string"
    }
  },
  "required": [
    "kind",
    "id",
    "label"
  ]
}
Business
{
  "type": "object",
  "properties": {
    "registry_number": {
      "type": "string",
      "pattern": "^[0-9]{1,20}$"
    },
    "name": {
      "type": "string",
      "minLength": 1
    },
    "trade_names": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "legal_form": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "inactive",
        "dissolved",
        "unknown"
      ]
    },
    "registered_at": {
      "type": "string",
      "format": "date"
    },
    "incorporated_at": {
      "type": "string",
      "format": "date"
    },
    "address": {
      "type": "object",
      "properties": {
        "street": {
          "type": "string"
        },
        "locality": {
          "type": "string"
        },
        "postal_code": {
          "type": "string"
        },
        "country_code": {
          "type": "string",
          "enum": [
            "CW"
          ]
        }
      },
      "required": [
        "country_code"
      ]
    },
    "activities": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "provenance": {
      "$ref": "#/components/schemas/Provenance"
    }
  },
  "required": [
    "registry_number",
    "name",
    "trade_names",
    "status",
    "activities",
    "provenance"
  ]
}
SchoolVacation
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^[a-z][a-z0-9-]*$"
    },
    "school_year": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{4}$"
    },
    "start_date": {
      "type": "string",
      "format": "date"
    },
    "end_date": {
      "type": "string",
      "format": "date"
    },
    "names": {
      "type": "object",
      "properties": {
        "pap": {
          "type": "string",
          "minLength": 1
        },
        "nl": {
          "type": "string",
          "minLength": 1
        },
        "en": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "nl"
      ]
    },
    "covers_school_boards": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "source_school_days": {
      "type": "integer"
    },
    "notes": {
      "type": "string"
    },
    "provenance": {
      "$ref": "#/components/schemas/Provenance"
    }
  },
  "required": [
    "id",
    "school_year",
    "start_date",
    "end_date",
    "names",
    "covers_school_boards",
    "provenance"
  ]
}
TariffObservation
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "product": {
      "type": "string"
    },
    "effective_from": {
      "type": "string",
      "format": "date"
    },
    "observation_kind": {
      "type": "string",
      "enum": [
        "advertising_end_user",
        "decree_retail_maximum"
      ]
    },
    "unit": {
      "type": "string"
    },
    "amount": {
      "type": "string",
      "pattern": "^-?\\d+(?:\\.\\d+)?$"
    },
    "currency_as_printed": {
      "type": "string"
    },
    "currency_code": {
      "type": "string",
      "enum": [
        "ANG",
        "XCG"
      ]
    },
    "unit_code": {
      "type": "string",
      "enum": [
        "liter",
        "cylinder",
        "kilowatt_hour",
        "cubic_meter",
        "hour",
        "month",
        "year"
      ]
    },
    "rate_group": {
      "type": "string"
    },
    "band": {
      "type": "string"
    },
    "base_amount": {
      "type": "string",
      "pattern": "^-?\\d+(?:\\.\\d+)?$"
    },
    "fuel_amount": {
      "type": "string",
      "pattern": "^-?\\d+(?:\\.\\d+)?$"
    },
    "amount_at_pump_as_printed": {
      "type": "string",
      "pattern": "^-?\\d+(?:\\.\\d+)?$"
    },
    "provenance": {
      "$ref": "#/components/schemas/Provenance"
    }
  },
  "required": [
    "id",
    "product",
    "effective_from",
    "observation_kind",
    "unit",
    "amount",
    "currency_as_printed",
    "provenance"
  ]
}
CensusIndicator
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "geography_id": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^gz_[a-z0-9]+(?:_[a-z0-9]+)*$"
        },
        {
          "type": "string",
          "pattern": "^nbh_[a-z0-9]+(?:_[a-z0-9]+)*$"
        }
      ]
    },
    "geography_type": {
      "type": "string",
      "enum": [
        "geozone",
        "neighborhood"
      ]
    },
    "geozone_id": {
      "type": "string",
      "pattern": "^gz_[a-z0-9]+(?:_[a-z0-9]+)*$"
    },
    "indicator": {
      "type": "string"
    },
    "census_year": {
      "type": "number",
      "enum": [
        2023
      ]
    },
    "value": {
      "type": "number"
    },
    "unit": {
      "type": "string",
      "enum": [
        "count",
        "persons_per_household"
      ]
    },
    "table": {
      "type": "string",
      "enum": [
        "G-1",
        "G-2",
        "G-3",
        "G-4",
        "G-5"
      ]
    },
    "provenance": {
      "$ref": "#/components/schemas/Provenance"
    }
  },
  "required": [
    "id",
    "geography_id",
    "geography_type",
    "indicator",
    "census_year",
    "value",
    "unit",
    "table",
    "provenance"
  ]
}
TourismArrival
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "period": {
      "type": "string",
      "pattern": "^\\d{4}-(0[1-9]|1[0-2])$"
    },
    "metric": {
      "type": "string",
      "enum": [
        "stayover",
        "cruise",
        "day_trippers"
      ]
    },
    "value": {
      "type": "integer",
      "minimum": 0
    },
    "unit": {
      "type": "string",
      "enum": [
        "arrivals"
      ]
    },
    "market": {
      "type": "string"
    },
    "provenance": {
      "$ref": "#/components/schemas/Provenance"
    }
  },
  "required": [
    "id",
    "period",
    "metric",
    "value",
    "unit",
    "provenance"
  ]
}
StatutoryRate
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "code": {
      "type": "string"
    },
    "kind": {
      "type": "string",
      "enum": [
        "min_wage",
        "poverty_line",
        "contribution_ceiling"
      ]
    },
    "effective_from": {
      "type": "string",
      "format": "date"
    },
    "effective_to": {
      "type": "string",
      "format": "date"
    },
    "applicability": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "kind": {
              "type": "string",
              "enum": [
                "employees"
              ]
            },
            "ages": {
              "type": "object",
              "properties": {
                "minimum": {
                  "type": "integer",
                  "minimum": 0
                },
                "maximum": {
                  "type": "integer",
                  "minimum": 0
                }
              },
              "required": [
                "minimum"
              ],
              "additionalProperties": false
            },
            "earnings_basis": {
              "type": "string",
              "enum": [
                "gross",
                "net"
              ]
            }
          },
          "required": [
            "kind",
            "ages",
            "earnings_basis"
          ]
        },
        {
          "type": "object",
          "properties": {
            "kind": {
              "type": "string",
              "enum": [
                "household"
              ]
            },
            "composition": {
              "type": "object",
              "properties": {
                "adults": {
                  "type": "integer",
                  "exclusiveMinimum": 0
                },
                "children": {
                  "type": "integer",
                  "minimum": 0
                }
              },
              "required": [
                "adults",
                "children"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "kind",
            "composition"
          ]
        },
        {
          "type": "object",
          "properties": {
            "kind": {
              "type": "string",
              "enum": [
                "insured_persons"
              ]
            },
            "scheme": {
              "type": "string"
            }
          },
          "required": [
            "kind",
            "scheme"
          ]
        }
      ]
    },
    "amount": {
      "type": "string",
      "pattern": "^\\d+(?:\\.\\d+)?$"
    },
    "currency_as_printed": {
      "type": "string"
    },
    "currency_code": {
      "type": "string",
      "enum": [
        "ANG",
        "XCG"
      ]
    },
    "unit_code": {
      "type": "string",
      "enum": [
        "liter",
        "cylinder",
        "kilowatt_hour",
        "cubic_meter",
        "hour",
        "month",
        "year"
      ]
    },
    "unit": {
      "type": "string"
    },
    "provenance": {
      "$ref": "#/components/schemas/Provenance"
    }
  },
  "required": [
    "id",
    "code",
    "kind",
    "effective_from",
    "applicability",
    "amount",
    "currency_as_printed",
    "unit",
    "provenance"
  ]
}
OfficialExchangeRate
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "rate_date": {
      "type": "string",
      "format": "date"
    },
    "currency_as_printed": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "currency": {
      "type": "string",
      "pattern": "^[a-z][a-z0-9_]*$"
    },
    "buy_notes": {
      "type": "string",
      "pattern": "^\\d+(?:\\.\\d+)?$"
    },
    "buy_cheques": {
      "type": "string",
      "pattern": "^\\d+(?:\\.\\d+)?$"
    },
    "sell": {
      "type": "string",
      "pattern": "^\\d+(?:\\.\\d+)?$"
    },
    "sell_cheques": {
      "type": "string",
      "pattern": "^\\d+(?:\\.\\d+)?$"
    },
    "provenance": {
      "$ref": "#/components/schemas/Provenance"
    }
  },
  "required": [
    "id",
    "rate_date",
    "currency_as_printed",
    "currency",
    "buy_notes",
    "buy_cheques",
    "sell",
    "provenance"
  ]
}
CpiObservation
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "period": {
      "type": "string",
      "pattern": "^\\d{4}-(0[1-9]|1[0-2])$"
    },
    "category_code": {
      "type": "string"
    },
    "category_name": {
      "type": "string"
    },
    "weight_2016": {
      "type": "integer"
    },
    "index_level": {
      "type": "string",
      "pattern": "^-?\\d+(?:\\.\\d+)?$"
    },
    "monthly_change_percent": {
      "type": "string",
      "pattern": "^-?\\d+(?:\\.\\d+)?$"
    },
    "base": {
      "type": "string"
    },
    "provenance": {
      "$ref": "#/components/schemas/Provenance"
    }
  },
  "required": [
    "id",
    "period",
    "category_code",
    "category_name",
    "base",
    "provenance"
  ]
}
WasteZone
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^wz_[a-z0-9_]+$"
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "provider_id": {
      "type": "string",
      "pattern": "^[a-z][a-z0-9_]*$"
    },
    "provider_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "service": {
      "type": "string",
      "enum": [
        "bulky_waste",
        "household_waste"
      ]
    },
    "places": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "pattern": "^wp_[a-z0-9_]+$"
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "neighborhood_id": {
            "type": "string",
            "pattern": "^nbh_[a-z0-9]+(?:_[a-z0-9]+)*$"
          }
        },
        "required": [
          "id",
          "name"
        ]
      }
    },
    "covered_neighborhood_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^nbh_[a-z0-9]+(?:_[a-z0-9]+)*$"
      },
      "maxItems": 500
    },
    "provenance": {
      "$ref": "#/components/schemas/Provenance"
    }
  },
  "required": [
    "id",
    "name",
    "provider_id",
    "provider_name",
    "service",
    "places",
    "covered_neighborhood_ids",
    "provenance"
  ]
}
WasteCollection
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^wc_[a-z0-9_]+$"
    },
    "zone_id": {
      "type": "string",
      "pattern": "^wz_[a-z0-9_]+$"
    },
    "set_out_window": {
      "type": "object",
      "properties": {
        "start_date": {
          "type": "string",
          "format": "date"
        },
        "end_date": {
          "type": "string",
          "format": "date"
        }
      },
      "required": [
        "start_date",
        "end_date"
      ]
    },
    "collection_window": {
      "type": "object",
      "properties": {
        "start_date": {
          "type": "string",
          "format": "date"
        },
        "end_date": {
          "type": "string",
          "format": "date"
        }
      },
      "required": [
        "start_date",
        "end_date"
      ]
    },
    "instructions": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000
    },
    "provenance": {
      "$ref": "#/components/schemas/Provenance"
    }
  },
  "required": [
    "id",
    "zone_id",
    "set_out_window",
    "instructions",
    "provenance"
  ]
}

Businesses (not yet available)

The business API has not launched. Company search and registry-number lookup are planned. Valid requests currently return 503 dataset_unavailable.

Search will require q. Results will contain entity information only, with no officers, UBOs, identity numbers or personal contact details. An API result is never an official Chamber excerpt.

Sources & licensing

Vokality licenses its original descriptions and documentation, and any copyright or database rights it holds in the selection and arrangement of Kòrsou.dev data, under CC BY 4.0. See Licensing for scope, exclusions and attribution.

Source and provenance license fields describe original provider terms, including unknown licensing. The Vokality grant does not relicense third-party source material.

Each dataset identifies its source and available license information. CBS permits republication with clear attribution under its reuse terms.

Each record includes its source, retrieval time and dataset version. Check /v1/datasets/{id} for current availability.