Skip to main content
Print

Head Start API Guide

Overview

The Head Start Center and Program API allows for programmatic access to the most recent Head Start center and program data.

Response Structure

A sample response from a Head Start Center Data Search is as follows:

format

All responses are of the content type application/json. Future versions of the API may include the option for XML response, but all future versions will have JSON as the default response.

results

The number of centers found for the search query. Note that searches with no results are valid queries, there are just no centers that fit the criteria. Try searching again with broader search criteria.

documents

An array of centers found by the query

addressLineOne

The primary address line of the center

addressLineTwo

The secondary address line of the center. This may be an empty string.

cid

The center id of the center. This unique, five-digit number can be used to find associated programs.

cid is a query parameter.

grantNumber

The grant number is the unique grant number of the center.

grantNumber is a query parameter.

delegateNumber

The delegate number of the center

type

The type code of the center. Types can be:

  1. Head Start Center
  2. Early Head Start Centers
  3. Migrant and Seasonal Head Start Center
  4. Migrant and Seasonal Early Head Start Center
  5. American Indian and Alaskan Native Head Start Center
  6. American Indian and Alaskan Native Early Head Start Center

latitude

The latitude of the center.

latitude is a query parameter.

longitude

The longitude of the center.

longitude is a query parameter.

name

The name of the center

city

The city of the center

city is a query parameter.

state

The state of the center

state is a query parameter.

zipFive

The five-digit ZIP code of the center. This is a string, not a number, to preserve leading zeroes.

zip is a query parameter.

zipFour

The four-digit zip code of the center. This is a string, not a number, to preserve leading zeroes. If there isn't a four-digit zip code associated with this center, the value will be -1.

phone

The phone number of the center

googleMapZoomLevel

The optimal zoom level for displaying the center in Google Maps. This will be optionally included in the next release of the API.

program

The subdocument, program, and references information about the program which services the center.

addressLineOne

The primary address line of the program

addressLineTwo

The secondary address line of the program. This may be an empty string.

name

The name of the program

city

The city of the program

state

The state of the program

zipFive

The five-digit zip code of the program. This is a string, not a number, to preserve leading zeroes.

zipFour

The four-digit zip code of the center. This is a string, not a number, to preserve leading zeroes. If there isn't a four-digit zip code associated with this center, the value will be -1.

phone

The phone number of the program

registrationPhone

The preferred registration contact number of the program

pid

The program id of the program. This unique, up-to-five-digit number can be used to find associated programs.

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?state=DC

{
          "results": 153,
          "documents": [
            {
              "addressLineOne": "2017 Savannah Ter SE",
              "addressLineTwo": "Ste 1",
              "cid": 43676,
              "grantNumber": "03CH3446",
              "delegateNumber": "000",
              "type": 1,
              "latitude": 38.8488,
              "longitude": -76.9749,
              "name": "Douglas Knolls - Apple Tree Institute",
              "city": "Washington",
              "state": "DC",
              "zipFive": "20020",
              "zipFour": "2127",
              "phone": "(202) 629-2545",
              "googleMapZoomLevel": 6,
              "program": {
                "addressLineOne": "301 Rhode Island Avenue, NW",
                "addressLineTwo": "",
                "name": "United Planning Organization",
                "city": "Washington",
                "state": "DC",
                "zipFive": "20001",
                "zipFour": "1826",
                "phone": "(202) 629-2545",
                "registrationPhone": "(202)238-4686",
                "pid": 6890
              }
            },
            ...
          ]
        }

Parameters and Errors

General Errors

Properly formed queries will return a count of documents as results and the documents themselves as documents. Any errors in the query will return a non-empty array of error messages as errors.

If the query is empty, the errors array will contain "Query cannot be empty". If the query is generally malformed, the errors array will contain either "Error creating query from given parameters" or "Malformed query".

If any individual query parameter exceeds 50 characters, the errors array will contain "Query parameters exceed maximum parameters length". Note that this is for each query parameter.

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?

{
          "results": 0,
          "documents": [],
          "errors": [
            "Query cannot be empty"
          ]
        }

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?null

{
          "results": 0,
          "documents": [],
          "errors": [
            "Error creating query from given parameters"
          ]
        }

City

City is case-sensitive single value. Spaces or "+" should be used to concatenate cities like city=New+Orleans. City names can include spaces, commas, and periods, but cannot contain special characters. Cities whose official names have special characters have been converted to their unaccented equivalent. For example, Añasco, Puerto Rico, can be queried with city=Anasco.

If the city name is invalid, the errors array will contain "City is invalid".

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?city=Chicago

{
          "results": 486,
          "documents": [ ... ]
        }

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?city=!

{
          "results": 0,
          "documents": [],
          "errors": [
            "City is invalid"
          ]
        }

State

State is a two-letter, case-insensitive postal code for the state. Included codes are for all 50 U.S. states and U.S. territories.

If the state code is invalid, the errors array will contain "State is invalid".

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?state=NY

{
          "results": 975,
          "documents": [ ... ]
        }

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?state=ZY

{
          "results": 0,
          "documents": [],
          "errors": [
            "State is invalid"
          ]
        }

Zip

Zip is the five-digit portion of a zip code.

If the zip code is invalid, the errors array will contain "Zip is invalid."

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?zip=20002

{
          "results": 15,
          "documents": [ ... ]
        }

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?zip=1234

{
          "results": 0,
          "documents": [],
          "errors": [
            "Zip is invalid"
          ]
        }

Grant Number

Grant number is the eight, 10, or 11 number associated with the center.

If the grant number is invalid, the errors array will contain "Grant number is invalid."

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?grantNumber=09CH9152

{
          "results": 196,
          "documents": [ ... ]
        }

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?grantNumber=09CH9152014

{
          "results": 23,
          "documents": [ ... ]
        }

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?grantNumber=014

{
          "results": 0,
          "documents": [],
          "errors": [
            "Grant number is invalid"
          ]
        }

Center ID

The CID of a center is a unique, five-digit number that can be used to get information about a specific center.

If the format is invalid, the errors array will contain "Center ID is invalid".

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?cid=43676

{
          "results": 1,
          "documents": [ ... ]
        }

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?cid=99999999

{
          "results": 0,
          "documents": [],
          "errors": [
            "Center ID is invalid"
          ]
        }

Type

Type can be a single number or a comma-separated array of numbers. Valid types include:

  1. Head Start Center
  2. Early Head Start Centers
  3. Migrant and Seasonal Head Start Center
  4. Migrant and Seasonal Early Head Start Center
  5. American Indian and Alaskan Native Head Start Center
  6. American Indian and Alaskan Native Early Head Start Center

If the type is invalid, the errors array will contain "Type <invalidType> is invalid" for each invalid type.

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?state=WA&type=1

{
          "results": 237,
          "documents": [ ... ]
        }

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?state=AK&type=1,6

{
          "results": 59,
          "documents": [ ... ]
        }

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?type=7

{
          "results": 0,
          "documents": [],
          "errors": [
            "\"Type <7> is invalid\""
          ]
        }

Longitude

Longitude is a number between -180 and 180 that specifies the starting longitude of a radius search. Longitude must be paired with latitude and radius.

If the longitude is invalid, the errors array will contain "Longitude is invalid".

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?latitude=38.9072&longitude=-77.0369&radius=5

{
          "results": 87,
          "documents": [ ... ]
        }

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?latitude=91&longitude=-181&radius=5

{
          "results": 0,
          "documents": [],
          "errors": [
            "Longitude is invalid"
          ]
        }

Latitude

Latitude is a number between -90 and 90 that specifies the starting latitude of a radius search. Latitude must be paired with longitude and radius.

If the latitude is invalid, the errors array will contain "Latitude is invalid".

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?latitude=38.9072&longitude=-77.0369&radius=5

{
          "results": 87,
          "documents": [ ... ]
        }

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?latitude=91&longitude=-77.0369&radius=5

{
          "results": 0,
          "documents": [],
          "errors": [
            "Latitude is invalid"
          ]
        }

Radius

Radius is a number between zero and 50 that specifies the radius in miles to search for centers from a given longitude and latitude. Radius must be paired with longitude and latitude.

If the radius is invalid, the errors array will contain "Radius is invalid".

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?latitude=38.9072&longitude=-77.0369&radius=5

{
          "results": 87,
          "documents": [ ... ]
        }

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?latitude=91&longitude=-77.0369&radius=51

{
          "results": 0,
          "documents": [],
          "errors": [
            "Radius is invalid"
          ]
        }

Head Start Program Data

This endpoint gets Head Start program data. Though request examples do not show it, please include a valid API Key with each request i.e. &apikey=MY_API_KEY

Response Structure

A sample response from a Head Start Program Data Search is as follows:

Format

All responses are of the content type application/json. Future versions of the API may include the option for XML response, but all future versions will have JSON as the default response.

results

The number of programs found for the search query. Note that searches with no results are valid queries, there are just no centers that fit the criteria. Try searching again with broader search criteria.

documents

An array of programs found by the query

addressLineOne

The primary address line of the program

addressLineTwo

The secondary address line of the program. This may be an empty string.

pid

The program id of the program. This unique, three- to five-digit number can be used to find associated centers.

pid is a query parameter.

grantNumber

The grant number is the unique grant number or associated with the program.

grantNumber is a query parameter.

delegateNumber

The delegate number of the program

type

The type code of the program. Types can be:

  1. Head Start Center
  2. Early Head Start Centers
  3. Migrant and Seasonal Head Start Center
  4. Migrant and Seasonal Early Head Start Center
  5. American Indian and Alaskan Native Head Start Center
  6. American Indian and Alaskan Native Early Head Start Center

name

The name of the center.

region

The region code of the program

region is a query parameter.

city

The city of the program

city is a query parameter.

state

The state of the program

state is a query parameter.

zipFive

The five-digit zip code of the program. This is a string, not a number, to preserve leading zeroes.

zip is a query parameter.

zipFour

The four-digit zip code of the program. This is a string, not a number, to preserve leading zeroes. If there isn't a four-digit zip code associated with this program, the value will be -1.

phone

The phone number of the program

registrationPhone

The preferred registration contact number of the program

fax

The fax number of the program

email

The preferred registration contact email of the program

website

The website of the program or an empty string

centers

The list of center IDs associated with the program. These can be used to find associated centers.

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/program?state=DE

{
          "results": 7,
          "documents": [
            {
              "addressLineOne": "100 West 10th Street, Suite 1016",
              "addressLineTwo": "",
              "pid": 6121,
              "grantNumber": "03CH3481",
              "delegateNumber": "000",
              "type": 1,
              "name": "WILMINGTON HEADSTART, INC",
              "granteeName": "WILMINGTON HEADSTART, INC",
              "region": 3,
              "city": "Wilmington",
              "state": "DE",
              "zipFive": "19801",
              "zipFour": "6607",
              "phone": "(302)421-3620 - 13",
              "registrationPhone": "(302)421-3620 - 13",
              "fax": "(302)421-3623",
              "email": "dathomas@wilmheadstar.org",
              "website": "wilmheadstart.org",
              "centers": [
                53326,
                53327,
                53328,
                53325
              ]
            },
            ...
          ]
        }

Parameters and Errors

General Errors

The same general errors for Head Start Center Data searches apply to Head Start Program Data.

City

The same center city search criteria and errors apply to city searches for programs.

State

The same center state search criteria and errors apply to state searches for programs.

Grant Number

The same center grant number search criteria and errors apply to state searches for programs.

Program ID

The PID of a program is a unique, three to five-digit number that can be used to get information about a specific program.

If the format is invalid, the errors array will contain "Program ID is invalid".

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/program?pid=5359

    {
              "results": 1,
              "documents": [ ... ]
            }

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/program?pid=0

    {
              "results": 0,
              "documents": [],
              "errors": [
                "Program ID is invalid"
              ]
            }

Type

The same center type search criteria and errors apply to type searches for programs.

Region

Region can be a single number or a comma-separated array of numbers. Valid regions are in a range from 1 to 12, representing the 12 federal regions for Head Start Programs.

If the region is invalid, the errors array will contain "Region <invalidType> is invalid" for each invalid type.

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/program?region=1

    {
              "results": 150,
              "documents": [ ... ]
            }

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/program?region=1,3

    {
              "results": 450,
              "documents": [ ... ]
            }

https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/program?region=16

    {
              "results": 0,
              "documents": [],
              "errors": [
                "\"Type <16> is invalid\""
              ]
            }

Program and Center IDs

Using the pid of center data and the centers array of programs, one can easily connect centers and programs using the https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/center?cid and https://eclkc.ohs.acf.hhs.gov/eclkc-apis/locator/program?pid queries. Future implementations of the API plan to make this process even easier by introducing findCenters and findPrograms on the program and center searches, respectively. This will have the functional effect of a join on each collection's unique IDs, returning both centers and programs specified.

Read more:

Web Standards