CORI Data API Specification (1.0.3)

Download OpenAPI specification:Download

License: MIT

BEAD broadband service info

BEAD block info - all

Return an array containing a GeoJSON representation of BEAD census block features along side lists of isp_tech and block_awards (i.e., rdof)

Authorizations:

CognitoAuth

query Parameters

geoid_bl	Array of strings Census block GEOID(s) to filter on; comma seperated list
geoid_tr	Array of strings Census tract GEOID(s) to filter on; comma seperated list
geoid_co	Array of strings County GEOID(s) to filter on; comma seperated list

Responses

Response samples

200
default

Content type

application/json

[{"type": "Feature",
"bbox": [0
],
"features": [{"type": "Feature",
"bbox": [0
],
"geometry": {"type": "Point",
"bbox": [0
]
},
"properties": { },
"id": 0
}
]
}
]

BEAD block info - geojson

Return an array containing a GeoJSON representation of census block features with broadband availability

Authorizations:

CognitoAuth

query Parameters

geoid_bl

Array of strings

Census block GEOID(s) to filter on; comma seperated list

Responses

Response samples

200
default

Content type

application/json

[{"type": "Feature",
"bbox": [0
],
"features": [{"type": "Feature",
"bbox": [0
],
"geometry": {"type": "Point",
"bbox": [0
]
},
"properties": { },
"id": 0
}
]
}
]

BEAD block info - isp_tech

Return an array containing ISP offerings for each census block by broadband technology and max advertised download/upload speeds

Authorizations:

CognitoAuth

query Parameters

geoid_bl

Array of strings

Census block GEOID(s) to filter on; comma seperated list

Responses

Response samples

200
default

Content type

application/json

[{ }
]

BEAD block info - block_award

Return an array containing any project covering the specified census blocks that was previously awarded federal funding (i.e., RDOF)

Authorizations:

CognitoAuth

query Parameters

geoid_bl

Array of strings

Census block GEOID(s) to filter on; comma seperated list

Responses

Response samples

200
default

Content type

application/json

[{ }
]

BEAD county summary - acs, bb and isp

Return an array containing a GeoJSON representation of BEAD county summary features with broadband availability and ACS stats along side lists of ISPs that serve the specified counties

Authorizations:

CognitoAuth

query Parameters

geoid_co

Array of strings

County GEOID(s) to filter on; comma seperated list

Responses

Response samples

200
default

Content type

application/json

[{"type": "Feature",
"bbox": [0
],
"features": [{"type": "Feature",
"bbox": [0
],
"geometry": {"type": "Point",
"bbox": [0
]
},
"properties": { },
"id": 0
}
]
}
]

BEAD county summary - acs

Return an array of properties with ACS statistics for each specified county

Authorizations:

CognitoAuth

query Parameters

geoid_co

Array of strings

County GEOID(s) to filter on; comma seperated list

Responses

Response samples

200
default

Content type

application/json

[{ }
]

BEAD county summary - isp

Return an array of ISPs and the number of locations that they serve in each specified county

Authorizations:

CognitoAuth

query Parameters

geoid_co

Array of strings

County GEOID(s) to filter on; comma seperated list

Responses

Response samples

200
default

Content type

application/json

[{ }
]

BEAD county summary - all

Return an array containing a GeoJSON representation of BEAD county summary features along side lists of isp_tech and block_awards (i.e., rdof)

Authorizations:

CognitoAuth

query Parameters

geoid_co

Array of strings

County GEOID(s) to filter on; comma seperated list

Responses

Response samples

200
default

Content type

application/json

[{"type": "Feature",
"bbox": [0
],
"features": [{"type": "Feature",
"bbox": [0
],
"geometry": {"type": "Point",
"bbox": [0
]
},
"properties": { },
"id": 0
}
]
}
]

BEAD isp - name to id lookup

Return a JSON key/value object in which the keys represent the names of every ISP that is serving at least one location at or above 25/3 and the values are the ISP identifier that we've assigned (isp_id) to that ISP name

Authorizations:

CognitoAuth

Responses

Response samples

200
default

Content type

application/json

{ }

BEAD isp - combos

Return a JSON key/value object in which the keys are the unique identifiers (combo_id) for every possible ISP combo and the values are arrays of combined ISP identifiers (isp_id)

Authorizations:

CognitoAuth

Responses

Response samples

200
default

Content type

application/json

{ }

BEAD isp - id to combo lookup

Return an array of objects, each representing an ISP identifier, name and all combos in which it is co-located with another ISP

Authorizations:

CognitoAuth

query Parameters

isp_id

Array of strings

ISP identifier(s)

Responses

Response samples

200
default

Content type

application/json

[{ }
]