Metadata-Version: 2.4
Name: fbi-data-api
Version: 0.6.0
Summary: Interface for extracting data assets from the FBI Crime Data API.
Project-URL: Homepage, https://github.com/teddythepooh/fbi_api
Project-URL: Issues, https://github.com/teddythepooh/fbi_api/issues
Author-email: "Ted Jesus C. Chua" <chuatedjesusc@gmail.com>
License-Expression: MIT
License-File: LICENSE
Requires-Python: >=3.12
Requires-Dist: pandas>=3.0.1
Requires-Dist: python-dotenv>=1.2.2
Requires-Dist: pyyaml>=6.0.3
Requires-Dist: requests>=2.32.5
Requires-Dist: tqdm>=4.67.3
Description-Content-Type: text/markdown

# FBI Crime Data API
This is a wrapper around the FBI Crime Data API, the first of its kind as of March 2026.

## Example
After signing up for an API key in https://api.data.gov/signup/, 

```bash
pip install fbi-data-api
```

```python
from fbi_api import FBI

# If no api_key is passed, your environment variable FBI_API_KEY is automatically invoked.
api = FBI(api_key = your_api_key)

metadata = api.get_metadata(state_abbr = "all") 

agency_metrics = api.get_agency_metrics(ori = "NY0303000", year = 2024)

crime_statistics = api.get_crime_statistics(ori = "NY0303000", year = 2024, offense = "Violent Crimes")
```
To see `fbi-data-api` in action, go to the repo's `examples` directory:

https://github.com/teddythepooh/fbi_api/tree/main/examples
