Core Information

Packages

Core data types and utilities.

Services for interacting with the query endpoints.

Base services for interacting with the event streaming API.

An abstraction of DbgCensus.EventStream providing an asynchronous and decoupled event handling model.

Getting Started with Census

Before you do anything, you should consider getting a custom Census Service ID. The process is free and it generally only takes a few hours to hear back about your registration, which you can do here.

Note that you can use the example service ID, however you will be rate-limited to 10 requests per minute, per client IP address.

You will also need to have a good understanding of how the Census API works. I highly recommend making your way through these excellent official/community resources:

• The official Census API documentation.
• Leonhard's Census API Primer.
• The community API issue tracker/info repository.
• Leonhard's unofficial docs for PlanetSide 2 endpoints.

Core Library Components

The Core library contains common types and extensions. Of these, it is likely you will find the Census types useful (DbgCensus.Core.Objects). There are:

• Enumerations of the faction, world, zone and metagame (definition and state) IDs that Census uses.
• An Optional<T> structure w/ relevant JSON converters that you can use to represent optional Census fields in your models.
• A ZoneID struct that represents Census' special zone ID format - see here for more info. JSON converters are registered by default for this type, so you can use it anywhere that you would normally use an integer zone ID in your models.
• A GlobalizedString structure that represents Census' globalized string fields:

  "name": {
      "de": "Spawn-Leuchte",
      "en": "Spawn Beacon",
      ...
  }

There are also converters, extensions and naming policies for System.Text.Json that you may find useful should you decide to perform your own JSON deserialization.