Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 1.93 KB

README.md

File metadata and controls

37 lines (23 loc) · 1.93 KB
Raw

NAACCR API Client

Quality Gate Status Maven Central

This library allows to call the NAACCR API using Java DTOs.

By default, it uses version 1.0 of the public API (https://apps.naaccr.org/data-dictionary/api/).

Download

The library is available on Maven Central.

To include it to your Maven or Gradle project, use the group ID com.imsweb and the artifact ID naaccr-api-client.

You can check out the release page for a list of the releases and their changes.

Usage

Create a client (using the NaaccrApiClient::getInstance method) and call the few methods that correspond to the API end points.

NaaccrApiClient client = NaaccrApiClient.getInstance();
NaaccrDataItem item = client.getDataItem(NAACCR_LATEST, "primarySite");
System.out.println(item.getItemName());

For a comprehensive list of available methods, see the javadocs of the NaaccrApiClient class.

About this library

This library was developed through the SEER program.

The Surveillance, Epidemiology and End Results program is a premier source for cancer statistics in the United States. The SEER program collects information on incidence, prevalence and survival from specific geographic areas representing a large portion of the US population and reports on all these data plus cancer mortality data for the entire country.