Members

HBZ Earth API Documentation

Accessing the API

The HBZ Earth API is available at https://api.hbzearth.com/api. All endpoints return data in JSON format.

  • Ordered Data: Some data is placed in arrays to preserve order, such as coordinates and permissions. The order matches the in-game order.
  • Omitted Data: Data is omitted if it does not exist. For example, if a town is not in a nation, the nation key will be absent. This reduces data size and makes handling missing values consistent. It is recommended to use try-catch or your language's equivalent when accessing optional data.
  • Versioning: Previous version endpoints are still available if you need to use older versions.

For detailed information on each endpoint, select one from the list below.