https://github.com/imsweb/naaccr-api-client

Wraps calls to the NAACCR API
https://github.com/imsweb/naaccr-api-client

Last synced: 24 days ago
JSON representation

Wraps calls to the NAACCR API

• Host: GitHub
• URL: https://github.com/imsweb/naaccr-api-client
• Owner: imsweb
• License: other
• Created: 2023-07-25T16:42:58.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2025-06-09T20:34:17.000Z (about 1 year ago)
• Last Synced: 2025-09-14T14:03:00.726Z (9 months ago)
• Language: Java
• Size: 243 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# NAACCR API Client

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=imsweb_naaccr-api-client&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=imsweb_naaccr-api-client)

[![Maven Central](https://img.shields.io/maven-central/v/com.imsweb/naaccr-api-client.svg)](https://central.sonatype.com/artifact/com.imsweb/naaccr-api-client)

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](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.imsweb%22%20AND%20a%3A%22naaccr-api-client%22).

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](https://github.com/imsweb/naaccr-api-client/releases) 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.

```java

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](https://github.com/imsweb/naaccr-api-client/blob/main/src/main/java/com/imsweb/naaccr/api/client/NaaccrApiClient.java) class.

## About this library

This library was developed through the [SEER](http://seer.cancer.gov/) 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.