https://github.com/nottimtam/ruca.js
An open-source API deployment for the USDA's Rural-Urban Commuting Area Codes.
https://github.com/nottimtam/ruca.js
api express nodejs npm rest-api ruca
Last synced: 2 months ago
JSON representation
An open-source API deployment for the USDA's Rural-Urban Commuting Area Codes.
- Host: GitHub
- URL: https://github.com/nottimtam/ruca.js
- Owner: NotTimTam
- License: cc0-1.0
- Created: 2023-01-21T04:24:58.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-21T18:35:32.000Z (about 3 years ago)
- Last Synced: 2024-12-29T01:32:39.333Z (about 1 year ago)
- Topics: api, express, nodejs, npm, rest-api, ruca
- Language: JavaScript
- Homepage:
- Size: 4.83 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ruca.js API v1
An open-source, **self-deployable** express API for querying the USDA's Rural-Urban Commuting Area Codes.
This lightweight API is meant to be customized and deployed on your server infrastructure for your needs.
For more information on RUCA codes, visit [this site](https://www.ers.usda.gov/data-products/rural-urban-commuting-area-codes/documentation/).
## Setup
Necessary `.env` parameters:
- `PORT`
- This is the port the API will be hosted on. If one is not provided, it defaults to `3000`.
- `VERSION_TARGET`
- The version of the API you would like to use. The only available version is `v1`, which is also the default.
- `REQUEST_LIMIT`
- The number of requests per 1 hour that an API client can make. (default `1000`)
Example:
```
PORT=8000
VERSION_TARGET=v1
REQUEST_LIMIT=1000
```
Make sure to run `npm i` to install all the necessary dependencies beforehand.
## Running the API
The API can be started by using `NODE.js` to run the `api.js` file in the root of the directory. There are also two `NPM Scripts`, `start` and `dev` which will do this. `dev` runs the API through the NPM package called [Nodemon](https://www.npmjs.com/package/nodemon).
## Documentation
### GET `RUCA OBJECTS`
- Method: **`GET`**
- Route: `/api/v1/`
- Query Parameters:
- All query parameters are **optional**, providing none will **return a list of all the data**.
- `FIPSCode`
- The [FIPS code](https://en.wikipedia.org/wiki/FIPS_county_code) to filter under.
- `state`
- The 2-letter state abbreviation to filter by. (ie., `AZ`) _(case-insensitive)_
- `county`
- The name of the county to filter by. _(case-insensitive)_
- `tractFIPSCode`
- The [state-county-tract FIPS code](http://www.ffiec.gov/Geocode/) to filter by.
- `primaryRUCACode`
- The primary RUCA code to filter by.
- `secondaryRUCACode`
- The secondary RUCA code to filter by.
- `population`
- The exact population number to filter by.
- `minPopulation`
- A minimum value on the population, showing only those that are greater than, or equal to the provided number.
- `maxPopulation`
- A cap on the maximum population, showing only those that are less than, or equal to the provided number.
- `landArea`
- The exact land area (**in square miles**) to filter by.
- `minLandArea`
- A cap on the maximum land area (**sq. mi**), showing only those that are greater than, or equal to the provided number.
- `maxLandArea`
- A minimum value on the land area (**sq. mi**), showing only those that are less than, or equal to the provided number.
- `popDensity`
- The exact population density (**per sq. mi**) to filter by.
- `minPopDensity`
- A cap on the maximum population density (**per sq. mi**), showing only those that are greater than, or equal to the provided number.
- `maxPopDensity`
- A minimum value on the population density (**per sq. mi**), showing only those that are less than, or equal to the provided number.
Example:
```javascript
axios.get(
"http://localhost:3000/api/v1/?state=AZ&PrimaryRUCACode=2&minPopulation=1500"
);
```
Learn more about Axios, an excellent HTTP client request tool, [here](https://www.npmjs.com/package/axios).