Resources JSON Feed

NRD provides a real-time JSON feed of all the NRD primary resource data.

Data Provided

The NRD Resources Feed provides information on each resource, including:

• Title
• Link
• Description of resource (content)
• Groups which may be interested in this resource (Family Member/Caregiver,  Service Member, Service Provider, Veterans)
• Geographic service locations (for the less than 10% of resources that provide a service at a specific location)
• Subject areas addressed by the resource (Employment, Health, etc)
• Additional fields, as descirbed in the JSON below format

Segmenting Data Transfers

To spread server load, JSON transfers are limited to 500 records.  Users can supply an "offset" to retrieve the next/previous page. The feed creates these calculations and supplies these numbers within the feed itself.  For example, calling https://www.nationalresourcedirectory.gov/api/v1/all returns:

{"total_resources":13513,"page_size":500,"total_pages":28,"current_offset":0,"next_offset":500,"previous_offset":0,  ….

Users can make the calls with the "offset" defined to either the next_offset or previous_offset value. This makes it much easier for the user to define custom pagination solutions for themselves.

Crediting NRD with Page Hits

We ask that sites using NRD data credit the NRD as the source of that data by including one of the following NRD badges on pages where NRD data is displayed.

<a href="http://www.NationalResourceDirectory.gov"><img src="http://static.nationalresourcedirectory.gov/partner_button_white.png" alt="NationalResourceDirectory.gov" /></a>

<a href="http://www.NationalResourceDirectory.gov"><img src="http://static.nationalresourcedirectory.gov/partner_button_blue.png" alt="NationalResourceDirectory.gov" /></a>

Additionally, click-track URLs (linkURL in the sample below) are included in the data set. These URLs will redirect to the resource URL after passing through the NRD server so traffic to the resource can be recorded. Since NRD's data maintenance strategy relies on accurate usage statistics, all data partners are required to use these beacons and click-tracking URLs.

Sample NRD Resource Item JSON Representation

The following example shows the JSON representation of an NRD resource content item.

Accessing the Feed

Anyone can access the feed by first creating a public user account at NRD.gov.  The JSON feed can then be accessed with these public user credentials at nrd.gov/api.  Layout for the JSON is described above.

Tailoring the Feed

You may talior the feed using the same options available for the RSS feeds.  For example, the following link will extract just the Alabama resources:  http://nrd.gov/api/state/alabama

The following link will extract the Employment resources: http://nrd.gov/api/topic/employment

The following link will extract the Education and Training resources: http://nrd.gov/api/topic/education_and_training