Metadata-Version: 2.4
Name: fbi-data-api
Version: 0.1.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: MIT License
        
        Copyright (c) 2026 Ted Jesus C. Chua
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
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
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/, 

```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")

# ORI stands for Originating Agency Identifer (ORI), uniquely identifying the law enforcement agencies that report
# to the FBI. The ORIs in a state can be extracted from api.get_metadata().
crime_statistics = api.get_crime_statistics(ori = "ILCPD0000", year = 2024, offense = "Violent Crimes")
```
