apiary.apib

FORMAT: 1A
HOST: https://api.policescorecard.org/v1

# API

* _Maintained By:_ __[Peter Schmalfeldt](https://peterschmalfeldt.com)__
* _Last Modified:_ __Feb 15th, 2025__
* _Current API Version:_ __v1.3.0__

# Group API Basics

## API Overview

Our API has a default Rate Limit by IP Address to `2500` calls per day. We add the following headers so you can monitor your API Rate:

* __X-Rate-Limit-Limit__: The rate limit ceiling for that given request
* __X-Rate-Limit-Remaining__: The number of requests left for the 24 hour window
* __X-Rate-Limit-Reset__: The remaining window before the rate limit resets in UTC [epoch seconds](http://en.wikipedia.org/wiki/Unix_time)

If a specific IP Address exceeds this limit, the API will return a 429 HTTP JSON Response Error.  A sample of this is provided in the Artwork API endpoint.

## API Authentication

Our API requires an API Key to use.  We are not providing API Keys to the general public at this time.  You likely received an API Key before accessing this documentation, if not, please contact the individual who sent you here.

## You can set the API Key one of two ways

#### Request Header:

* __API-Key__ `243CEA2E-7E63-D2C4-3D2D-1A114288274B` _( this is not an actual API Key )_

#### GET Parameter:

* __?apikey=__ `243CEA2E-7E63-D2C4-3D2D-1A114288274B`

### HTTP Request Method Limits

### Common API Responses

The following parameters are available on every API endpoint and used for pagination
for if there are a lot of results.

+ `notices` (array, optional) - An array of API Notices.  These notices are for the API to let the Developer know something that might be helpful, but will not impact the API results.
+ `warnings` (array, optional) - An array of API Warnings.  These warnings explain why the API might have had issues returning results.
+ `errors` (array, optional) - An array of API Errors.  These errors explain why the API prevented returning results.
+ `field_errors` (object, optional) - If the error was in regards to data entry, any errors specific to an input field will return here with the input name and error message.
+ `meta` (object) - The META data object that contains the basic information about the API response.
+ `meta.total` (number) - Total number of all results.  Not just the number returned in the API call.
+ `meta.showing` (number) - Number of results returned in the current API call ( may be less than total results ).
+ `meta.pages` (number) - Number of pages of results.  This is based on the `total` results divided by the `pageSize`.
+ `meta.page` (number) - Current Page
+ `data` (object or array) - This is the the actual data returned for the API call.  For API calls that are expected to return a single result, the `data` will be an Object.  For API calls that are expecting multiple items returned, `data` will be returned as an array ( even if there is only one item returned, such as search results, etc ).
+ `data.policescorecard_url` (string) - This will exist for results that have custom pages on the https://policescorecard.org website.

__Response 200:__ (application/json)

```
{
  "notices": [],
  "warnings": [],
  "errors": [],
  "field_errors": {},
  "meta": {
    "total": 97,
    "showing": 30,
    "pages": 4,
    "page": 1
  },
  "data": [
    ...
  ]
}
```

__Response 403:__ (application/json)

```
{
  "notices": [],
  "warnings": [],
  "errors": ["Missing API Key"],
  "field_errors": {},
  "meta": {
    "total": 0,
    "showing": 0,
    "pages": 1,
    "page": 1
  },
  "data": []
}
```

### Optional API Params

The following parameters are available on most API endpoint and used for pagination
for if there are a lot of results.

+ `apikey` (string) - Your Police Scorecard API Key
+ `fields` (string) - Comma Separated List of fields you want in the response.  By default all public fields will be returned, but if you only need specific fields you can greatly simplify your API response by specifying them.
+ `pageSize` (number, optional) - How many results to return in a single API call. Defaults to 30
+ `page` (number, optional) - If there is more than one page of results, you can set which page to load here
+ `sort` (optional, string, `population_rank`) - Comma Separated List of fields you want to sort by
+ `order` (optional, string, `asc`) - Comma Separated List of Order Methods
+ `pretty` (optional) - If you want to format the JSON response to be human readable, just add a `pretty` param in the API call ( it does not need a value )

### Request Authorization Header

* __Authorization:__ Bearer `token`

An example API Header would look like this:

```
curl --data '' https://api.policescorecard.org/v1/user/refresh/ -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOiIyIiwiaWF0IjoxNDUxNzEyNzg0LCJleHAiOjE0NTIzMTc1ODQsImlzcyI6IkRvaW5nIEFQSSJ9.x3eJutiulLnJCJkl_jP9ETj43ihePVeMtaWgWF0I60w"
```

# Group API Access

All access to our API will require an Authentication Token. The following endpoint will
get your access to endpoints that do not require user authentication.

## Token [/token]

You will not be able to make a request to our API without a `token` sent in an
Authorization Header.  This `/token` endpoint is the only public endpoint open to
allow a `token` to be requested.  This endpoint is only required for anonymous users
that have not logged in.  Once the user logs in, you will need to use the `token` that
is sent back for that user, as it will be used for authenticating that specific user.

Once a user has logged in, you will need to send over their Authentication
Token in the HTTP Header.  A `token` is returned with a successful login.  A session
token is valid for 7 days.  You can refresh your token to prevent having to log in
again by either adding the Request Authorization Header below, or using the
`/api/0.1/user/refresh/` endpoint.

### Get Token [GET]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1Nzc5MjY2ODUsImV4cCI6MTU3ODUzMTQ4NSwiaXNzIjoiQVBJIn0.tC2KwBJyBDmyOuYCQjrmOYx0-KPPFKE6qC8sO3h09Sw"
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

## Refresh Session [/user/refresh]

A `token` is returned with a successful login.  A session token is valid for 7 days.
You can refresh your token to prevent having to log in again by either adding the
Request Authorization Header below. `token` should be the string returned in the
`token` parameter from a successful login.

* __Authorization:__ Bearer `token`

### Refresh Session [POST]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": {
            "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOjIsImlhdCI6MTQ1MTc5ODYyMSwiZXhwIjoxNDUyNDAzNDIxLCJpc3MiOiJEb2luZyBBUEkifQ.za4PspEZfeVxydO3QHSFBLm_9PcrCBRwK9HLofBY74s"
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 400 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [
            "Invalid or expired token"
          ],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": null,
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

# Group Account Management

The following endpoints are specifically setup to manage the logged in users account.

## Register [/user/register/?username={username}&password={password}&retype_password={retype_password}&inviteCode={inviteCode}&first_name={first_name}&last_name={last_name}&email={email}&agree={agree}]

API Endpoint to register new users. This should set the user's `activated` field
to `true` unless they've included their email address. If so, `activated` is
`false` and the user will be sent an email with a `new_email_key` key to confirm
their email address to complete registration.

+ Parameters
    + username (string, required) - The username or email address of the account
        + Min Length: __3__
        + Max Length: __30__
        + Characters Allowed: __a-zA-Z0-9___
        + Case Insensitive
    + password (string, required) - The password to the account
        + Min Length: __6__
        + No Other Password Requirements :)
    + retype_password (string, required) - The password to the account
        + Min Length: __6__
        + No Other Password Requirements :)
    + inviteCode (string, required) - During Alpha / Beta testing, an Invitation Code is Required for registration
        + Length: __6__
        + Existing Users: __hash_id__
    + first_name (string, optional) - First Name - NOTE: Apple does not like requiring personal info for registration
        + Min Length: __1__
        + Max Length: __50__
    + last_name (string, optional) - Last Name - NOTE: Apple does not like requiring personal info for registration
        + Min Length: __1__
        + Max Length: __50__
    + email (string, optional) - Email Address - NOTE: Apple does not like requiring personal info for registration
        + Min Length: __1__
        + Max Length: __100__
    + agree (string, required) - Agree to TOS - User Agreed to Terms of Service

### User Register [POST]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "activated": false,
            "banned": false,
            "created_date": "2020-01-02T01:11:05.008Z",
            "email": "john.doe@fake.com",
            "first_name": "John",
            "hash_id": "WJvqzv",
            "id": 3,
            "last_name": "Doe",
            "modified_date": "2020-01-02T01:11:05.008Z",
            "profile_name": "john_doe",
            "username": "john_doe"
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 400 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {
            "username": [
              "Username is already in use"
            ],
            "email": [
              "Email is already in use"
            ]
          },
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": null,
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

## Confirm Account [/user/confirm/account/?key={key}]

During account registration, new users will be sent a link to confirm their
email address.  The users account will be disabled until the user confirms the email
address.

+ Parameters
    + key (required, string) - The `new_email_key` stored for the user

### Confirm Account [GET]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "activated": true,
            "banned": false,
            "banned_reason": null,
            "bio": null,
            "company_name": null,
            "created_date": "2020-01-02T02:10:23.000Z",
            "deletedAt": null,
            "email": "jane.doe@fake.com",
            "first_name": "Jane",
            "hash_id": "LYvlRm",
            "id": 2,
            "last_name": "Doe",
            "location": null,
            "modified_date": "2020-01-02T02:15:20.457Z",
            "new_password_key": null,
            "profile_link_1": null,
            "profile_link_2": null,
            "profile_link_3": null,
            "profile_link_twitter": null,
            "profile_link_website": null,
            "profile_name": "jane_doe",
            "profile_photo": null,
            "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjIsImlhdCI6MTU3NzkzMTMyMCwiZXhwIjoxNTc4NTM2MTIwLCJpc3MiOiJBUEkifQ.GjxhhS7WLZcNrbnbULPZ1RiFUF_1ctMNZMxSx3k4Mkk",
            "username": "jane_doe"
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 400 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [
            "Activation Key not found"
          ],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": null,
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

## Confirm Email Change [/user/confirm/email/?key={key}]

When a user changes their email, they will be sent a confirmation email to both
their new and old email address assuring it was them that requested the email
change.

+ Parameters
    + key (required, string) - The `new_email_key` stored for the user

### Confirm Email Change [GET]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "activated": true,
            "banned": false,
            "banned_reason": null,
            "bio": null,
            "company_name": null,
            "created_date": "2020-01-02T02:10:23.000Z",
            "deletedAt": null,
            "email": "jane.doe2@fake.com",
            "first_name": "Jane",
            "hash_id": "LYvlRm",
            "id": 2,
            "last_name": "Doe",
            "location": null,
            "modified_date": "2020-01-02T02:26:45.454Z",
            "new_password_key": null,
            "profile_link_1": null,
            "profile_link_2": null,
            "profile_link_3": null,
            "profile_link_twitter": null,
            "profile_link_website": null,
            "profile_name": "jane_doe",
            "profile_photo": null,
            "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjIsImlhdCI6MTU3NzkzMjAwNSwiZXhwIjoxNTc4NTM2ODA1LCJpc3MiOiJBUEkifQ.G0c_x6pt1djFAFyr9SY-3Q295NsMVgQu95hDSkc4h7s",
            "username": "jane_doe"
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 400 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [
            "Confirmation Key not found"
          ],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": null,
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

## Confirm Password Change [/user/confirm/password/?key={key}]

When a user changes their password, they will be sent a confirmation email assuring
it was them that requested the password change.

+ Parameters
    + key (required, string) - The `new_password_key` stored for the user

### Confirm Password Change [GET]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "activated": true,
            "banned": false,
            "banned_reason": null,
            "bio": null,
            "company_name": null,
            "created_date": "2020-01-02T02:10:23.000Z",
            "deletedAt": null,
            "email": "jane.doe@fake.com",
            "first_name": "Jane",
            "hash_id": "LYvlRm",
            "id": 2,
            "last_name": "Doe",
            "location": null,
            "modified_date": "2020-01-02T02:32:13.794Z",
            "new_password_key": null,
            "profile_link_1": null,
            "profile_link_2": null,
            "profile_link_3": null,
            "profile_link_twitter": null,
            "profile_link_website": null,
            "profile_name": "jane_doe",
            "profile_photo": null,
            "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjIsImlhdCI6MTU3NzkzMjMzMywiZXhwIjoxNTc4NTM3MTMzLCJpc3MiOiJBUEkifQ.s_ykYP-rQuJJH41y7lZODWAc2RIamZGYw_GGPhwElD4",
            "username": "jane_doe"
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 400 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [
            "Confirmation Key not found"
          ],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": null,
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

## Login [/user/login/?username={username}&password={password}]

Some of the API endpoints will require authentication. Those endpoints will
require the `token` returned from a successful login.

To access authentication-protected endpoints, you will need to include an
`Authorization` HTTP header in the format: `Bearer (token)`.

+ Parameters
    + username (string, required) - The username of the account
    + password (string, required) - The password to the account

### User Login [POST]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "activated": true,
            "banned": false,
            "banned_reason": null,
            "bio": null,
            "company_name": null,
            "created_date": "2020-01-02T02:10:23.000Z",
            "deletedAt": null,
            "email": "jane.doe@fake.com",
            "first_name": "Jane",
            "hash_id": "LYvlRm",
            "id": 2,
            "last_name": "Doe",
            "location": null,
            "modified_date": "2020-01-02T02:32:13.000Z",
            "new_password_key": null,
            "profile_link_1": null,
            "profile_link_2": null,
            "profile_link_3": null,
            "profile_link_twitter": null,
            "profile_link_website": null,
            "profile_name": "jane_doe",
            "profile_photo": null,
            "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjIsImlhdCI6MTU3NzkzNDA3MiwiZXhwIjoxNTc4NTM4ODcyLCJpc3MiOiJBUEkifQ.sHfJ-iFk1TZYPbO4MBneuFvyKu6PwkALSU-QcyvZLGc",
            "username": "jane_doe"
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 401 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [
            "Incorrect Password"
          ],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": null,
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

## Logout [/user/logout]

Tell API that the user has logged out. This will only register if a Bearer Authentication Token is set in the Header.

### User Logout [POST]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "success": true
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 403 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [
            "Invalid API Authorization Token"
          ],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": null,
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

## Forgot Password [/user/forgot-password/?email={email}]

Forgot password will require an email address that is requesting for the password
reset link.

+ Parameters
    + email (required, string) - The email address of the account

### User Forgot Password [POST]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "activated": true,
            "banned": false,
            "banned_reason": null,
            "bio": null,
            "company_name": null,
            "created_date": "2020-01-02T02:10:23.000Z",
            "deletedAt": null,
            "email": "jane.doe@fake.com",
            "first_name": "Jane",
            "hash_id": "LYvlRm",
            "id": 2,
            "last_name": "Doe",
            "location": null,
            "modified_date": "2020-01-02T03:15:33.321Z",
            "new_password_key": "RBiNnDqOJUaX",
            "profile_link_1": null,
            "profile_link_2": null,
            "profile_link_3": null,
            "profile_link_twitter": null,
            "profile_link_website": null,
            "profile_name": "jane_doe",
            "profile_photo": null,
            "username": "jane_doe"
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 400 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [
            "No Matching Email Found"
          ],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": null,
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

## Reset Password [/user/reset-password/?token={token}&password={password}&retype_password={retype_password}]

Reset password will check the token against the `new_password_key` column for that user.  We will also likely want to make sure that `new_password_requested` is less than a certain age to prevent open password change requests.

+ Parameters
    + token (required, string) - This is the `new_password_key` token that is sent from the link in the email address.
    + password (required, string) - This is the new password that the user wants to reset
    + retype_password (required, string) - This should be the same as 'password' and is the confirmation of the password

### User Reset Password [POST]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "activated": true,
            "banned": false,
            "banned_reason": null,
            "bio": null,
            "company_name": null,
            "created_date": "2020-01-02T02:10:23.000Z",
            "deletedAt": null,
            "email": "jane.doe@fake.com",
            "first_name": "Jane",
            "hash_id": "LYvlRm",
            "id": 2,
            "last_name": "Doe",
            "location": null,
            "modified_date": "2020-01-02T03:52:48.714Z",
            "new_password_key": null,
            "profile_link_1": null,
            "profile_link_2": null,
            "profile_link_3": null,
            "profile_link_twitter": null,
            "profile_link_website": null,
            "profile_name": "jane_doe",
            "profile_photo": null,
            "username": "jane_doe"
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 400 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [
            "Request Invalid or Expired"
          ],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": null,
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

## Resend Email Confirmation [/user/resend-confirmation/{hash_id}]

If the user needs to resend their email confirmation, this is the endpoint to use.

+ Parameters
    + hash_id (required, string) - This is the hash id of the user

### Resend Email Confirmation [GET]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": "Confirmation Email Resent",
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 400 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [
            "Invalid Request"
          ],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": null,
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

## Update Account [/user/update/?username={username}&password={password}&new_username={new_username}&new_email={new_email}&password_new={password_new}&password_new_retype={password_new_retype}]

This endpoint will allow the logged in user to update their own account.  This uses the current Authentication Bearer Token to lookup who's account to update.

The Bearer Token is created during login and contains the users ID from our database.  You will not be able to use this endpoint to manage anyone elses account except your own.

IMPORTANT NOTES ABOUT THIS ENDPOINT:

1. Changing the username will immediatley make the old username available to the world for use.  We do check to make sure that the new username being requested is available.
2. We do not immediatley change the email when requested.  Instead we send a confirmation email to both the new and old email to confirm the requested change.
3. We do not immediatley change the password when requested.  We first send a confirmation email to the users current email to confirm that they made the requested change.

+ Parameters
    + username (required, string) - Current Account Username ( required to make any changes on this endpoint )
    + password (required, string) - Current Account Passsword ( required to make any changes on this endpoint )
    + new_username (optional, string) - New Username user wishes to change their username to
    + new_email (optional, string) - New Email Address user wishes to associate with their account
    + password_new (optional, string) - New Password user wishes to use for their account
    + password_new_retype (optional, string) - Repeat the new password to make sure they match so they don't get locked out

### Update Account [POST]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "messages": [
              "Your username has been updated to \"jane_ray\". A confirmation of this change has been sent to your email address."
            ],
            "title": "Account Updated",
            "user": {
              "id": 2,
              "activated": true,
              "username": "jane_ray",
              "password": "$2b$08$iIW30arfYVRi28u6sUIkU.ZOHddmtzLRRVBgjaEyZR3Cr34wTfCBK",
              "email": "jane.doe@fake.com",
              "first_name": "Jane",
              "last_name": "Doe",
              "company_name": null,
              "profile_name": "jane_doe",
              "profile_photo": null,
              "location": null,
              "profile_link_website": null,
              "profile_link_twitter": null,
              "profile_link_1": null,
              "profile_link_2": null,
              "profile_link_3": null,
              "bio": null,
              "banned": false,
              "banned_reason": null,
              "new_password": null,
              "new_password_key": null,
              "new_password_requested": null,
              "new_email": null,
              "new_email_key": null,
              "new_email_requested": null,
              "created_date": "2020-01-02T02:10:23.000Z",
              "modified_date": "2020-01-02T05:34:14.102Z",
              "deletedAt": null
            }
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 400 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [
            "Incorrect Username"
          ],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": null,
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

## Delete Account [/user/delete/?username={username}&password={password}]

This endpoint only works for the currently logged in user using the Authorization
Bearer Header Token.  Once that is verified there is a second check to require the
account holders username and password to double check that they just did not steal
the Authentication Header to try to steal / delete the users account.

IMPORTANT NOTES ABOUT THIS ENDPOINT:

1. This will permanently delete the users account
2. This will also permanently delete all data generated by the user
3. There is no way to undo this

+ Parameters
    + username (required, string) - Current Account User
    + password (required, string) - Current Account Password

### Delete Account [DELETE]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "activated": true,
            "banned": false,
            "banned_reason": null,
            "bio": null,
            "company_name": null,
            "created_date": "2020-01-02T02:10:23.000Z",
            "deletedAt": null,
            "email": "jane.doe@fake.com",
            "first_name": "Jane",
            "hash_id": "LYvlRm",
            "id": 2,
            "last_name": "Doe",
            "location": null,
            "modified_date": "2020-01-02T05:34:14.000Z",
            "new_password_key": null,
            "profile_link_1": null,
            "profile_link_2": null,
            "profile_link_3": null,
            "profile_link_twitter": null,
            "profile_link_website": null,
            "profile_name": "jane_doe",
            "profile_photo": null,
            "username": "jane_ray"
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 400 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [
            "Incorrect Username"
          ],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": null,
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }


# Group User Interaction

The following endpoints are for accessing specific public data about a given
username.  No private information is accessible from these endpoints.

## Get User Profile [/user/{username}/profile]

Get a public profile for given `username`.

+ Parameters
    + username (required, string) - Username for requested profile

### Get User Profile [GET]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "bio": null,
            "company_name": null,
            "email": "jane.doe@fake.com",
            "first_name": "Jane",
            "last_name": "Doe",
            "location": null,
            "profile_link_1": null,
            "profile_link_2": null,
            "profile_link_3": null,
            "profile_link_twitter": null,
            "profile_link_website": null,
            "profile_name": "jane_doe",
            "profile_photo": null,
            "username": "jane_doe"
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 400 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [
            "No Matching Username"
          ],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": [],
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

## Follow User [/user/{username}/follow]

Add's `username` to the current logged in users follow list.

+ Parameters
    + username (required, string) - Username of user you wish to follow

### Follow User [POST]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "created_date": "2020-01-02T07:30:58.951Z",
            "follow_user_id": 14,
            "id": 1,
            "modified_date": "2020-01-02T07:30:58.951Z",
            "user_id": 13
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 400 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [
            "No user found for user johnd_doe"
          ],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": null,
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

## Unfollow User [/user/{username}/unfollow]

Removes `username` from the current logged in users follow list.

+ Parameters
    + username (required, string) - Username of user you wish to unfollow

### Unfollow User [POST]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "created_date": "2020-01-02T07:30:58.000Z",
            "deletedAt": "2020-01-02T07:34:27.538Z",
            "follow_user_id": 14,
            "id": 1,
            "modified_date": "2020-01-02T07:34:27.539Z",
            "user_id": 13
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 400 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [
            "You are not following john_doe"
          ],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": null,
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

## Get Followers [/user/{username}/followers]

Fetches list of users that is following `username`

+ Parameters
    + username (required, string) - Username to get followers list for

### Get Followers [GET]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": [
            {
              "id": 3,
              "username": "john_doe",
              "profile_name": "john_doe",
              "profile_photo": "https://secure.gravatar.com/avatar/c701e8fbe4b56a80543dbd80c157f853?r=g&s=200&d=identicon",
              "followed_on": "2020-01-02T07:44:47.000Z"
            }
          ],
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 400 (application/json)

        {
          "error": true,
          "errors": [
            "Missing Username"
          ],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": []
        }

## Get Following [/user/{username}/following]

Fetches list of users `username` is following

+ Parameters
    + username (required, string) - Username to get following list for

### Get Following [GET]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": [
            {
              "id": 2,
              "username": "john_doe",
              "profile_name": "john_doe",
              "profile_photo": "https://secure.gravatar.com/avatar/c701e8fbe4b56a80543dbd80c157f853?r=g&s=200&d=identicon",
              "followed_on": "2020-01-02T07:43:39.000Z"
            }
          ],
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 400 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [
            "Missing Username"
          ],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": null,
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

## Get Invitations [/user/invite/{key}]

Fetches list of users that have registered using the provided invite `key` ( users `hash_id` ).

+ Parameters
    + key (required, string) - Invitation Key ( users hash_id )

### Get Invitations [GET]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": [
            {
              "id": 2,
              "username": "manifestinteractive",
              "profile_name": "Peter Schmalfeldt",
              "profile_photo": "https://peterschmalfeldt.com/images/me.jpg",
              "followed_on": "2016-03-05T08:30:04.000Z"
            }
          ],
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 400 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [
            "Invalid Invitation Code"
          ],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": null,
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

# Group User Settings

The following endpoints for accessing & managing settings for the current logged
in user.  These endpoints only work for the user associated with the Authorization
Bearer Token sent in the header.  This uses the current Authentication Bearer Token
to lookup who's account to update. The Bearer Token is created during login and contains
the users ID from our database.  You will not be able to use this endpoint to manage
anyone elses account except your own.

## Get User Settings [/settings]

Gets account settings for current logged in user

### Get User Settings [GET]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "notifications": {
              "email_comment_left": true,
              "email_comment_liked": false,
              "email_mentioned_in_comment": true,
              "email_someone_follows": true,
              "newsletter": true,
              "web_comment_left": true,
              "web_comment_liked": false,
              "web_mentioned_in_comment": true,
              "web_someone_follows": true
            }
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

## Update Profile [/settings/profile/?profile_photo={profile_photo}&profile_name={profile_name}&location={location}&company_name={company_name}&first_name={first_name}&last_name={last_name}&bio={bio}]

This endpoint will allow the logged in user to update their own account profile.

+ Parameters
    + profile_photo (optional, string) - absolute path to location of User Avatar ( must be HTTPS to prevent issues )
        + Max Length: `255`
        + Default: null
    + profile_name (optional, string) - Public Display Name of User
        + Max Length: `100`
        + Default: Users Username
    + location (optional, string) - Public Pysical Location of User
        + Max Length: `50`
        + Default: null
    + company_name (optional, string) - Public Company the User works for
        + Max Length: `100`
        + Default: null
    + first_name (optional, string) - Private First Name ( never shown on site - for internal use only )
        + Max Length: `100`
        + Default: null
    + last_name (optional, string) - Private Last Name ( never shown on site - for internal use only )
        + Max Length: `100`
        + Default: null
    + bio (optional, string) - Public User Bio to display on website
        + Max Length: `255`
        + Default: null

### Update Profile [POST]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "activated": true,
            "banned": false,
            "banned_reason": null,
            "bio": "I make things on the internet.",
            "company_name": "Police Scorecard",
            "created_date": "2020-01-02T07:42:43.000Z",
            "deletedAt": null,
            "email": "jane.doe@fake.com",
            "first_name": "Jane",
            "hash_id": "bJvJPv",
            "id": 15,
            "last_name": "Doe",
            "location": "St. Petersburg, FL",
            "modified_date": "2020-01-04T01:22:56.000Z",
            "new_password_key": null,
            "profile_link_1": null,
            "profile_link_2": null,
            "profile_link_3": null,
            "profile_link_twitter": null,
            "profile_link_website": null,
            "profile_name": "Jane Doe",
            "profile_photo": "https://gravatar.com/avatar/a9601f3839e5d5da764c1861a5e1daf6?s=200",
            "username": "jane_doe"
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 400 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [
            "No user found with ID Error: Missing Header Token"
          ],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": null,
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

## Update Social Links [/settings/social-links/?profile_link_github={profile_link_github}&profile_link_bitbucket={profile_link_bitbucket}&profile_link_twitter={profile_link_twitter}&profile_link_1={profile_link_1}&profile_link_2={profile_link_2}&profile_link_3={profile_link_3}]

This endpoint will allow the logged in user to update their own accounts Social Links.

+ Parameters
    + profile_link_github (optional, string) - Absolute URL to Github Profile Page
        + Max Length: `100`
        + Default: null
    + profile_link_bitbucket (optional, string) - Absolute URL to Bitbucket Profile Page
        + Max Length: `100`
        + Default: null
    + profile_link_twitter (optional, string) - Absolute URL to Twitter Profile Page
        + Max Length: `100`
        + Default: null
    + profile_link_1 (optional, string) - Absolute URL to a URL of the Users Choosing
        + Max Length: `100`
        + Default: null
    + profile_link_2 (optional, string) - Absolute URL to a URL of the Users Choosing
        + Max Length: `100`
        + Default: null
    + profile_link_3 (optional, string) - Absolute URL to a URL of the Users Choosing
        + Max Length: `100`
        + Default: null

### Update Social Links [POST]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "activated": true,
            "banned": false,
            "banned_reason": null,
            "bio": "I make things on the internet.",
            "company_name": "Police Scorecard",
            "created_date": "2020-01-02T07:42:43.000Z",
            "deletedAt": null,
            "email": "jane.doe@fake.com",
            "first_name": "Jane",
            "hash_id": "bJvJPv",
            "id": 15,
            "last_name": "Doe",
            "location": "St. Petersburg, FL",
            "modified_date": "2020-01-04T01:36:25.313Z",
            "new_password_key": null,
            "profile_link_1": "https://policescorecard.org",
            "profile_link_2": "",
            "profile_link_3": "",
            "profile_link_twitter": "https://twitter.com/policescorecard",
            "profile_name": "Jane Doe",
            "profile_photo": "https://gravatar.com/avatar/a9601f3839e5d5da764c1861a5e1daf6?s=200",
            "username": "jane_doe"
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 400 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [
            "No user found with ID Error: Missing Header Token"
          ],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": null,
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

## Update Email Notifications [/settings/email-notifications/?email_comment_left={email_comment_left}&email_comment_liked={email_comment_liked}&email_project_liked={email_project_liked}&email_someone_follows={email_someone_follows}&email_mentioned_in_comment={email_mentioned_in_comment}]

This endpoint will allow the logged in user to update their own accounts email notification settings.

+ Parameters
    + email_comment_left (boolean, optional) - Send Email when Comment Left
        + Default: true
    + email_comment_liked (boolean, optional) - Send Email when Comment Liked
        + Default: true
    + email_project_liked (boolean, optional) - Send Email when Project Liked
        + Default: true
    + email_someone_follows (boolean, optional) - Send Email when Someone Follows
        + Default: true
    + email_mentioned_in_comment (boolean, optional) - Send Email when Mentioned in Comment
        + Default: true

### Update Email Notifications [POST]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "created_date": "2020-01-04T01:42:50.622Z",
            "email_comment_left": true,
            "email_comment_liked": false,
            "email_mentioned_in_comment": true,
            "email_someone_follows": true,
            "id": 2,
            "modified_date": "2020-01-04T01:42:50.622Z",
            "newsletter": true,
            "user_id": 15,
            "web_comment_left": true,
            "web_comment_liked": true,
            "web_mentioned_in_comment": true,
            "web_someone_follows": true
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 400 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [
            "Unable to set email notifications"
          ],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": null,
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

## Update Web Notifications [/settings/web-notifications/?web_comment_left={web_comment_left}&web_comment_liked={web_comment_liked}&web_project_liked={web_project_liked}&web_someone_follows={web_someone_follows}&web_mentioned_in_comment={web_mentioned_in_comment}]

This endpoint will allow the logged in user to update their own accounts web notification settings.

+ Parameters
    + web_comment_left (boolean, optional) - Send Web / Push Notification when Comment Left
        + Default: true
    + web_comment_liked (boolean, optional) - Send Web / Push Notification when Comment Liked
        + Default: true
    + web_project_liked (boolean, optional) - Send Web / Push Notification when Project Liked
        + Default: true
    + web_someone_follows (boolean, optional) - Send Web / Push Notification when Someone Follows
        + Default: true
    + web_mentioned_in_comment (boolean, optional) - Send Web / Push Notification when Mentioned in Comment
        + Default: true

### Update Web Notifications [POST]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "created_date": "2020-01-04T01:42:50.000Z",
            "deletedAt": null,
            "email_comment_left": true,
            "email_comment_liked": false,
            "email_mentioned_in_comment": true,
            "email_someone_follows": true,
            "id": 2,
            "modified_date": "2020-01-04T01:48:25.884Z",
            "newsletter": true,
            "user_id": 15,
            "web_comment_left": true,
            "web_comment_liked": false,
            "web_mentioned_in_comment": true,
            "web_someone_follows": true
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 400 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [
            "Unable to set web notifications"
          ],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": null,
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

# Group META Data

The following endpoints for accessing META Data used across the API, such as Categories
and Tags. Helpful for generating select lists to connect more meaningful data atributes
to other API models.

## Categories [/categories/{slug}]

Fetch a list of all categories.  Optionally, you can pass over a `slug` for a category to get a list of subcategories for that category.

+ Parameters
    + slug (optional, string) - Main category `slug` that will return subcategories

### Get Categories [GET]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 2,
            "showing": 2,
            "pages": 1,
            "page": 1
          },
          "data": [
            {
              "id": 1,
              "parent_id": null,
              "name": "Category One",
              "slug": "category-one",
              "subcategories": [
                {
                  "id": 3,
                  "parent_id": 1,
                  "name": "Subcategory One",
                  "slug": "subcategory-one"
                },
                {
                  "id": 4,
                  "parent_id": 1,
                  "name": "Subcategory Two",
                  "slug": "subcategory-two"
                },
                {
                  "id": 5,
                  "parent_id": 1,
                  "name": "Subcategory Three",
                  "slug": "subcategory-three"
                }
              ]
            },
            {
              "id": 2,
              "parent_id": null,
              "name": "Category Two",
              "slug": "category-two",
              "subcategories": [
                {
                  "id": 6,
                  "parent_id": 2,
                  "name": "Subcategory One",
                  "slug": "subcategory-one"
                },
                {
                  "id": 7,
                  "parent_id": 2,
                  "name": "Subcategory Two",
                  "slug": "subcategory-two"
                },
                {
                  "id": 8,
                  "parent_id": 2,
                  "name": "Subcategory Three",
                  "slug": "subcategory-three"
                }
              ]
            }
          ]
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

## Tags [/tags]

Fetch a list of all tags being used.

### Get Tags [GET]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 3,
            "showing": 3,
            "pages": 1,
            "page": 1
          },
          "data": [
            {
              "id": 1,
              "name": "Tag One",
              "slug": "tag-one"
            },
            {
              "id": 2,
              "name": "Tag Two",
              "slug": "tag-two"
            },
            {
              "id": 3,
              "name": "Tag Three",
              "slug": "tag-three"
            }
          ],
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

# Group Scorecard

The following endpoints for accessing Scorecard Data used across the API.

## State [/scorecard/state/{state}]

Get Scorecard Data for a Given State. Fetch a list of Police and Sheriff Departments for the provided `state`.

+ Parameters
    + state (required, string) - Two Letter State Abbreviation

### Get Summary for a Single State [GET]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "average_grade_class": "f",
            "average_grade_letter": "F",
            "average_grade_marker": "f",
            "average_score": 52,
            "police-department": [
              {
                "agency_name": "New York",
                "district": null,
                "grade_class": "d",
                "grade_letter": "D-",
                "grade_marker": "d-minus",
                "latitude": 40.7123,
                "longitude": -74.0017,
                "overall_score": 62,
                "population": 8523171,
                "slug": "new-york",
                "title": "New York, New York Police Department",
                "url": "/?state=ny&type=police-department&location=new-york",
                "url_pretty": "/ny/police-department/new-york"
              },
              {
                "agency_name": "Buffalo",
                "district": null,
                "grade_class": "f",
                "grade_letter": "F",
                "grade_marker": "f",
                "latitude": 42.8832,
                "longitude": -78.8778,
                "overall_score": 45,
                "population": 258219,
                "slug": "buffalo",
                "title": "Buffalo, New York Police Department",
                "url": "/?state=ny&type=police-department&location=buffalo",
                "url_pretty": "/ny/police-department/buffalo"
              },
              {
                "agency_name": "Rochester",
                "district": null,
                "grade_class": "f",
                "grade_letter": "F",
                "grade_marker": "f",
                "latitude": 43.1518,
                "longitude": -77.6118,
                "overall_score": 34,
                "population": 207701,
                "slug": "rochester",
                "title": "Rochester, New York Police Department",
                "url": "/?state=ny&type=police-department&location=rochester",
                "url_pretty": "/ny/police-department/rochester"
              }
            ],
            "sheriff": [
              {
                "agency_name": "Suffolk County Pd",
                "district": "us-ny-103",
                "grade_class": "f",
                "grade_letter": "F",
                "grade_marker": "f",
                "latitude": null,
                "longitude": null,
                "overall_score": 16,
                "population": 1301590,
                "slug": "suffolk-county-pd",
                "title": "Suffolk County Pd, New York Sheriff",
                "url": "/?state=ny&type=sheriff&location=suffolk-county-pd",
                "url_pretty": "/ny/sheriff/suffolk-county-pd"
              },
              {
                "agency_name": "Nassau",
                "district": "us-ny-059",
                "grade_class": "f",
                "grade_letter": "F",
                "grade_marker": "f",
                "latitude": null,
                "longitude": null,
                "overall_score": 43,
                "population": 1047751,
                "slug": "nassau",
                "title": "Nassau, New York Sheriff",
                "url": "/?state=ny&type=sheriff&location=nassau",
                "url_pretty": "/ny/sheriff/nassau"
              },
              {
                "agency_name": "Monroe",
                "district": "us-ny-055",
                "grade_class": "f",
                "grade_letter": "F",
                "grade_marker": "f",
                "latitude": null,
                "longitude": null,
                "overall_score": 57,
                "population": 228701,
                "slug": "monroe",
                "title": "Monroe, New York Sheriff",
                "url": "/?state=ny&type=sheriff&location=monroe",
                "url_pretty": "/ny/sheriff/monroe"
              }
            ],
            "total_agencies": 201,
            "total_overall_score": 10580,
            "total_population": 18504882
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 400 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [
            "Invalid `state` parameter"
          ],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": null,
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

## States [/scorecard/states]

Get Scorecard Summary for a All States. Returns Police and Sheriff Departments Summary Totals for entire state, and and per department.

### Get Summary for All States [GET]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "AK": {
              "average_grade_class": "f",
              "average_grade_letter": "F",
              "average_grade_marker": "f",
              "average_score": 50,
              "total_agencies": 4,
              "total_overall_score": 200,
              "total_population": 366071,
              "total_people_killed": 22,
              "total_arrests": 111108,
              "total_complaints_reported": 0,
              "total_complaints_sustained": 0,
              "total_black_people_killed": 3,
              "total_black_population": 17,
              "total_hispanic_people_killed": 2,
              "total_hispanic_population": 34,
              "total_white_people_killed": 8,
              "total_white_population": 258,
              "total_low_level_arrests": 68240,
              "total_violent_crime_arrests": 8304,
              "total_arrests_2013": 21431,
              "total_arrests_2014": 18507,
              "total_arrests_2015": 18039,
              "total_arrests_2016": 17017,
              "total_arrests_2017": 17929,
              "total_arrests_2018": 18197,
              "total_arrests_2019": 12345,
              "police-department": [
                {
                  "agency_name": "Anchorage",
                  "district": null,
                  "grade_class": "f",
                  "grade_letter": "F",
                  "grade_marker": "f",
                  "latitude": 61.179,
                  "longitude": -149.8078,
                  "overall_score": 47,
                  "population": 291992,
                  "people_killed": 13,
                  "arrests": 87870,
                  "complaints_reported": 0,
                  "complaints_sustained": 0,
                  "black_population": 5,
                  "hispanic_population": 9,
                  "white_population": 59,
                  "black_people_killed": 1,
                  "hispanic_people_killed": 1,
                  "white_people_killed": 5,
                  "low_level_arrests": 53660,
                  "violent_crime_arrests": 7182,
                  "arrests_2013": 17601,
                  "arrests_2014": 14748,
                  "arrests_2015": 14387,
                  "arrests_2016": 13294,
                  "arrests_2017": 13871,
                  "arrests_2018": 13973,
                  "arrests_2019": 12345,
                  "slug": "anchorage",
                  "title": "Anchorage, Alaska Police Department",
                  "url_pretty": "/ak/police-department/anchorage",
                  "url": "/?state=ak&type=police-department&location=anchorage"
                },
                {
                  "agency_name": "Juneau",
                  "district": null,
                  "grade_class": "f",
                  "grade_letter": "F",
                  "grade_marker": "f",
                  "latitude": 58.3559,
                  "longitude": -134.508,
                  "overall_score": 24,
                  "population": 31922,
                  "people_killed": 1,
                  "arrests": 10248,
                  "complaints_reported": null,
                  "complaints_sustained": null,
                  "black_population": 1,
                  "hispanic_population": 7,
                  "white_population": 65,
                  "black_people_killed": 0,
                  "hispanic_people_killed": 0,
                  "white_people_killed": 0,
                  "low_level_arrests": 6615,
                  "violent_crime_arrests": 609,
                  "arrests_2013": 1447,
                  "arrests_2014": 1413,
                  "arrests_2015": 1632,
                  "arrests_2016": 1760,
                  "arrests_2017": 2029,
                  "arrests_2018": 1968,
                  "arrests_2019": 1234,
                  "slug": "juneau",
                  "title": "Juneau, Alaska Police Department",
                  "url_pretty": "/ak/police-department/juneau",
                  "url": "/?state=ak&type=police-department&location=juneau"
                },
                {
                  "agency_name": "Fairbanks",
                  "district": null,
                  "grade_class": "d",
                  "grade_letter": "D",
                  "grade_marker": "d",
                  "latitude": 64.8392,
                  "longitude": -147.7184,
                  "overall_score": 64,
                  "population": 31635,
                  "people_killed": 6,
                  "arrests": 8406,
                  "complaints_reported": null,
                  "complaints_sustained": null,
                  "black_population": 9,
                  "hispanic_population": 12,
                  "white_population": 58,
                  "black_people_killed": 0,
                  "hispanic_people_killed": 1,
                  "white_people_killed": 3,
                  "low_level_arrests": 4317,
                  "violent_crime_arrests": 428,
                  "arrests_2013": 1607,
                  "arrests_2014": 1649,
                  "arrests_2015": 1269,
                  "arrests_2016": 1248,
                  "arrests_2017": 1254,
                  "arrests_2018": 1381,
                  "arrests_2019": 1234,
                  "slug": "fairbanks",
                  "title": "Fairbanks, Alaska Police Department",
                  "url_pretty": "/ak/police-department/fairbanks",
                  "url": "/?state=ak&type=police-department&location=fairbanks"
                }
              ]
            },
            "AL": {
              "average_grade_class": "f",
              "average_grade_letter": "F",
              "average_grade_marker": "f",
              "average_score": 44,
              "total_agencies": 117,
              "total_overall_score": 5161,
              "total_population": 3939555,
              "total_people_killed": 109,
              "total_arrests": 465596,
              "total_complaints_reported": 0,
              "total_complaints_sustained": 0,
              "total_black_people_killed": 11,
              "total_black_population": 1654,
              "total_hispanic_people_killed": 1,
              "total_hispanic_population": 192,
              "total_white_people_killed": 24,
              "total_white_population": 3884,
              "total_low_level_arrests": 99489,
              "total_violent_crime_arrests": 9871,
              "total_arrests_2013": 0,
              "total_arrests_2014": 0,
              "total_arrests_2015": 37533,
              "total_arrests_2016": 46239,
              "total_arrests_2017": 34326,
              "total_arrests_2018": 34279,
              "total_arrests_2019": 12345,
              "police-department": [
                {
                  "agency_name": "Mobile",
                  "district": null,
                  "grade_class": "d",
                  "grade_letter": "D-",
                  "grade_marker": "d-minus",
                  "latitude": 30.673,
                  "longitude": -88.0989,
                  "overall_score": 60,
                  "population": 245475,
                  "people_killed": 6,
                  "arrests": 28368,
                  "complaints_reported": 0,
                  "complaints_sustained": 0,
                  "black_population": 51,
                  "hispanic_population": 3,
                  "white_population": 43,
                  "black_people_killed": 4,
                  "hispanic_people_killed": 0,
                  "white_people_killed": 2,
                  "low_level_arrests": 11068,
                  "violent_crime_arrests": 3141,
                  "arrests_2013": null,
                  "arrests_2014": null,
                  "arrests_2015": 7382,
                  "arrests_2016": 6912,
                  "arrests_2017": 7122,
                  "arrests_2018": 6952,
                  "arrests_2019": 1234,
                  "slug": "mobile",
                  "title": "Mobile, Alabama Police Department",
                  "url_pretty": "/al/police-department/mobile",
                  "url": "/?state=al&type=police-department&location=mobile"
                },
                {
                  "agency_name": "Birmingham",
                  "district": null,
                  "grade_class": "f",
                  "grade_letter": "F",
                  "grade_marker": "f",
                  "latitude": 33.5129,
                  "longitude": -86.8096,
                  "overall_score": 28,
                  "population": 210564,
                  "people_killed": 7,
                  "arrests": 8658,
                  "complaints_reported": 0,
                  "complaints_sustained": 0,
                  "black_population": 70,
                  "hispanic_population": 4,
                  "white_population": 23,
                  "black_people_killed": 4,
                  "hispanic_people_killed": 0,
                  "white_people_killed": 3,
                  "low_level_arrests": 5104,
                  "violent_crime_arrests": 2292,
                  "arrests_2013": null,
                  "arrests_2014": null,
                  "arrests_2015": null,
                  "arrests_2016": 3738,
                  "arrests_2017": null,
                  "arrests_2018": 4920,
                  "arrests_2019": 1234,
                  "slug": "birmingham",
                  "title": "Birmingham, Alabama Police Department",
                  "url_pretty": "/al/police-department/birmingham",
                  "url": "/?state=al&type=police-department&location=birmingham"
                },
                {
                  "agency_name": "Montgomery",
                  "district": null,
                  "grade_class": "f",
                  "grade_letter": "F",
                  "grade_marker": "f",
                  "latitude": 32.3818,
                  "longitude": -86.2977,
                  "overall_score": 36,
                  "population": 198662,
                  "people_killed": 3,
                  "arrests": 2176,
                  "complaints_reported": 0,
                  "complaints_sustained": 0,
                  "black_population": 61,
                  "hispanic_population": 4,
                  "white_population": 31,
                  "black_people_killed": 2,
                  "hispanic_people_killed": 0,
                  "white_people_killed": 1,
                  "low_level_arrests": 329,
                  "violent_crime_arrests": 566,
                  "arrests_2013": null,
                  "arrests_2014": null,
                  "arrests_2015": 746,
                  "arrests_2016": 539,
                  "arrests_2017": 370,
                  "arrests_2018": 521,
                  "arrests_2019": 123,
                  "slug": "montgomery",
                  "title": "Montgomery, Alabama Police Department",
                  "url_pretty": "/al/police-department/montgomery",
                  "url": "/?state=al&type=police-department&location=montgomery"
                }
              ],
              "sheriff": [
                {
                  "agency_name": "Jefferson",
                  "district": "us-al-073",
                  "grade_class": "f",
                  "grade_letter": "F",
                  "grade_marker": "f",
                  "latitude": null,
                  "longitude": null,
                  "overall_score": 22,
                  "population": 146385,
                  "people_killed": 5,
                  "arrests": 3308,
                  "complaints_reported": 0,
                  "complaints_sustained": 0,
                  "black_population": 42,
                  "hispanic_population": 4,
                  "white_population": 50,
                  "black_people_killed": 3,
                  "hispanic_people_killed": 0,
                  "white_people_killed": 1,
                  "low_level_arrests": 1978,
                  "violent_crime_arrests": 261,
                  "arrests_2013": null,
                  "arrests_2014": null,
                  "arrests_2015": 566,
                  "arrests_2016": 765,
                  "arrests_2017": 1020,
                  "arrests_2018": 958,
                  "arrests_2019": 1234,
                  "slug": "jefferson",
                  "title": "Jefferson, Alabama Sheriff",
                  "url_pretty": "/al/sheriff/jefferson",
                  "url": "/?state=al&type=sheriff&location=jefferson"
                },
                {
                  "agency_name": "Madison",
                  "district": "us-al-089",
                  "grade_class": "f",
                  "grade_letter": "F",
                  "grade_marker": "f",
                  "latitude": null,
                  "longitude": null,
                  "overall_score": 33,
                  "population": 118757,
                  "people_killed": 4,
                  "arrests": 9330,
                  "complaints_reported": 0,
                  "complaints_sustained": 0,
                  "black_population": 24,
                  "hispanic_population": 5,
                  "white_population": 65,
                  "black_people_killed": 1,
                  "hispanic_people_killed": 0,
                  "white_people_killed": 2,
                  "low_level_arrests": 6263,
                  "violent_crime_arrests": 806,
                  "arrests_2013": null,
                  "arrests_2014": null,
                  "arrests_2015": 2720,
                  "arrests_2016": 3115,
                  "arrests_2017": null,
                  "arrests_2018": 3496,
                  "arrests_2019": 1234,
                  "slug": "madison",
                  "title": "Madison, Alabama Sheriff",
                  "url_pretty": "/al/sheriff/madison",
                  "url": "/?state=al&type=sheriff&location=madison"
                },
                {
                  "agency_name": "Baldwin",
                  "district": "us-al-003",
                  "grade_class": "f",
                  "grade_letter": "F",
                  "grade_marker": "f",
                  "latitude": null,
                  "longitude": null,
                  "overall_score": 28,
                  "population": 100960,
                  "people_killed": 3,
                  "arrests": 18030,
                  "complaints_reported": 0,
                  "complaints_sustained": 0,
                  "black_population": 10,
                  "hispanic_population": 4,
                  "white_population": 83,
                  "black_people_killed": 0,
                  "hispanic_people_killed": 0,
                  "white_people_killed": 3,
                  "low_level_arrests": 11994,
                  "violent_crime_arrests": 1996,
                  "arrests_2013": null,
                  "arrests_2014": null,
                  "arrests_2015": 5867,
                  "arrests_2016": 6103,
                  "arrests_2017": 6062,
                  "arrests_2018": null,
                  "arrests_2019": 1234,
                  "slug": "baldwin",
                  "title": "Baldwin, Alabama Sheriff",
                  "url_pretty": "/al/sheriff/baldwin",
                  "url": "/?state=al&type=sheriff&location=baldwin"
                }
              ]
            },
            "AR": {
              "average_grade_class": "f",
              "average_grade_letter": "F",
              "average_grade_marker": "f",
              "average_score": 46,
              "total_agencies": 106,
              "total_overall_score": 4888,
              "total_population": 2492556,
              "total_people_killed": 79,
              "total_arrests": 656400,
              "total_complaints_reported": 0,
              "total_complaints_sustained": 0,
              "total_black_people_killed": 2,
              "total_black_population": 973,
              "total_hispanic_people_killed": 1,
              "total_hispanic_population": 370,
              "total_white_people_killed": 24,
              "total_white_population": 5246,
              "total_low_level_arrests": 135396,
              "total_violent_crime_arrests": 6992,
              "total_arrests_2013": 28685,
              "total_arrests_2014": 26939,
              "total_arrests_2015": 27942,
              "total_arrests_2016": 29759,
              "total_arrests_2017": 29171,
              "total_arrests_2018": 28482,
              "total_arrests_2019": 12345,
              "police-department": [
                {
                  "agency_name": "Little Rock",
                  "district": null,
                  "grade_class": "f",
                  "grade_letter": "F",
                  "grade_marker": "f",
                  "latitude": 34.7494,
                  "longitude": -92.2776,
                  "overall_score": 45,
                  "population": 199288,
                  "people_killed": 13,
                  "arrests": 52296,
                  "complaints_reported": 158,
                  "complaints_sustained": 68,
                  "black_population": 42,
                  "hispanic_population": 7,
                  "white_population": 46,
                  "black_people_killed": 7,
                  "hispanic_people_killed": 1,
                  "white_people_killed": 3,
                  "low_level_arrests": 33895,
                  "violent_crime_arrests": 2624,
                  "arrests_2013": 9798,
                  "arrests_2014": 5746,
                  "arrests_2015": 6961,
                  "arrests_2016": 9443,
                  "arrests_2017": 9518,
                  "arrests_2018": 10835,
                  "arrests_2019": 12345,
                  "slug": "little-rock",
                  "title": "Little Rock, Arkansas Police Department",
                  "url_pretty": "/ar/police-department/little-rock",
                  "url": "/?state=ar&type=police-department&location=little-rock"
                },
                {
                  "agency_name": "Fort Smith",
                  "district": null,
                  "grade_class": "f",
                  "grade_letter": "F",
                  "grade_marker": "f",
                  "latitude": 35.3826,
                  "longitude": -94.4237,
                  "overall_score": 56,
                  "population": 88290,
                  "people_killed": 1,
                  "arrests": 51582,
                  "complaints_reported": 129,
                  "complaints_sustained": 20,
                  "black_population": 10,
                  "hispanic_population": 19,
                  "white_population": 60,
                  "black_people_killed": 1,
                  "hispanic_people_killed": 0,
                  "white_people_killed": 0,
                  "low_level_arrests": 40601,
                  "violent_crime_arrests": 1620,
                  "arrests_2013": 8427,
                  "arrests_2014": 7780,
                  "arrests_2015": 9038,
                  "arrests_2016": 9156,
                  "arrests_2017": 8968,
                  "arrests_2018": 8217,
                  "arrests_2019": 1234,
                  "slug": "fort-smith",
                  "title": "Fort Smith, Arkansas Police Department",
                  "url_pretty": "/ar/police-department/fort-smith",
                  "url": "/?state=ar&type=police-department&location=fort-smith"
                },
                {
                  "agency_name": "Fayetteville",
                  "district": null,
                  "grade_class": "f",
                  "grade_letter": "F",
                  "grade_marker": "f",
                  "latitude": 36.0611,
                  "longitude": -94.161,
                  "overall_score": 21,
                  "population": 87008,
                  "people_killed": 2,
                  "arrests": 22476,
                  "complaints_reported": 0,
                  "complaints_sustained": 0,
                  "black_population": 7,
                  "hispanic_population": 9,
                  "white_population": 77,
                  "black_people_killed": 1,
                  "hispanic_people_killed": 0,
                  "white_people_killed": 1,
                  "low_level_arrests": 16345,
                  "violent_crime_arrests": 802,
                  "arrests_2013": 3229,
                  "arrests_2014": 3108,
                  "arrests_2015": 3477,
                  "arrests_2016": 3707,
                  "arrests_2017": 4376,
                  "arrests_2018": 4581,
                  "arrests_2019": 1234,
                  "slug": "fayetteville",
                  "title": "Fayetteville, Arkansas Police Department",
                  "url_pretty": "/ar/police-department/fayetteville",
                  "url": "/?state=ar&type=police-department&location=fayetteville"
                }
              ],
              "sheriff": [
                {
                  "agency_name": "Garland",
                  "district": "us-ar-051",
                  "grade_class": "f",
                  "grade_letter": "F",
                  "grade_marker": "f",
                  "latitude": null,
                  "longitude": null,
                  "overall_score": 40,
                  "population": 61898,
                  "people_killed": 1,
                  "arrests": 9606,
                  "complaints_reported": 0,
                  "complaints_sustained": 0,
                  "black_population": 8,
                  "hispanic_population": 5,
                  "white_population": 83,
                  "black_people_killed": 0,
                  "hispanic_people_killed": 0,
                  "white_people_killed": 1,
                  "low_level_arrests": 7253,
                  "violent_crime_arrests": 813,
                  "arrests_2013": 1362,
                  "arrests_2014": 1605,
                  "arrests_2015": 1606,
                  "arrests_2016": 1787,
                  "arrests_2017": 1746,
                  "arrests_2018": 1503,
                  "arrests_2019": 1234,
                  "slug": "garland",
                  "title": "Garland, Arkansas Sheriff",
                  "url_pretty": "/ar/sheriff/garland",
                  "url": "/?state=ar&type=sheriff&location=garland"
                },
                {
                  "agency_name": "Saline",
                  "district": "us-ar-125",
                  "grade_class": "f",
                  "grade_letter": "F",
                  "grade_marker": "f",
                  "latitude": null,
                  "longitude": null,
                  "overall_score": 50,
                  "population": 52241,
                  "people_killed": 0,
                  "arrests": 1825,
                  "complaints_reported": 0,
                  "complaints_sustained": 0,
                  "black_population": 6,
                  "hispanic_population": 5,
                  "white_population": 86,
                  "black_people_killed": 0,
                  "hispanic_people_killed": 0,
                  "white_people_killed": 0,
                  "low_level_arrests": 1093,
                  "violent_crime_arrests": 214,
                  "arrests_2013": null,
                  "arrests_2014": 25,
                  "arrests_2015": 199,
                  "arrests_2016": 267,
                  "arrests_2017": 518,
                  "arrests_2018": 817,
                  "arrests_2019": 1234,
                  "slug": "saline",
                  "title": "Saline, Arkansas Sheriff",
                  "url_pretty": "/ar/sheriff/saline",
                  "url": "/?state=ar&type=sheriff&location=saline"
                },
                {
                  "agency_name": "Pulaski",
                  "district": "us-ar-119",
                  "grade_class": "f",
                  "grade_letter": "F",
                  "grade_marker": "f",
                  "latitude": null,
                  "longitude": null,
                  "overall_score": 48,
                  "population": 50104,
                  "people_killed": 1,
                  "arrests": 64632,
                  "complaints_reported": null,
                  "complaints_sustained": null,
                  "black_population": 36,
                  "hispanic_population": 6,
                  "white_population": 53,
                  "black_people_killed": 0,
                  "hispanic_people_killed": 0,
                  "white_people_killed": 1,
                  "low_level_arrests": 60325,
                  "violent_crime_arrests": 905,
                  "arrests_2013": 10189,
                  "arrests_2014": 9504,
                  "arrests_2015": 10523,
                  "arrests_2016": 11742,
                  "arrests_2017": 11263,
                  "arrests_2018": 11414,
                  "arrests_2019": 12345,
                  "slug": "pulaski",
                  "title": "Pulaski, Arkansas Sheriff",
                  "url_pretty": "/ar/sheriff/pulaski",
                  "url": "/?state=ar&type=sheriff&location=pulaski"
                }
              ]
            }
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

## Report [/scorecard/report/{state}/{type}/{location}]

Get Detailed Report Scorecard for a single department.

+ Parameters
    + state (required, string) - Two Letter State Abbreviation
    + type (required, string) - Type of Department
        + Options: `sheriff`, `police-department`
    + location (required, string) - This is the `slug` version of the Location
        + Example: `new-york` if you were searching for `New York`
        + Example: `st-louis` if you were searching for `St. Louis`

### Get Detailed Report for a Department [GET]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "agency": {
              "asian_pacific_population": 14,
              "black_population": 22,
              "hispanic_population": 29,
              "mayor_contact_url": null,
              "mayor_email": null,
              "mayor_name": "Bill De Blasio",
              "mayor_phone": "212-788-7585",
              "name": "New York",
              "ori": "NY0303000",
              "other_population": 3,
              "police_chief_contact_url": null,
              "police_chief_email": null,
              "police_chief_name": null,
              "police_chief_phone": null,
              "slug": "new-york",
              "total_population": 8523171,
              "type": "police-department",
              "white_population": 32
            },
            "arrests": {
              "arrests_2013": 393809,
              "arrests_2014": 387727,
              "arrests_2015": 339470,
              "arrests_2016": 314864,
              "arrests_2017": 286225,
              "arrests_2018": 246773,
              "arrests_2019": 123456,
              "asian_pacific_arrests": 91674,
              "black_arrests": 941676,
              "black_drug_arrests": 152570,
              "hispanic_arrests": 669995,
              "hispanic_drug_arrests": 124012,
              "low_level_arrests": 1049435,
              "non_black_drug_arrests": 184305,
              "other_arrests": 26017,
              "other_drug_arrests": 13509,
              "violent_crime_arrests": 160119,
              "white_arrests": 239506,
              "white_drug_arrests": 46784
            },
            "geo": {
              "country": {
                "abbr2": "US",
                "abbr3": "USA",
                "fips_code": "US",
                "name": "United States"
              },
              "state": {
                "abbr": "NY",
                "code": "US-NY",
                "fips_code": "36",
                "name": "New York",
                "type": "state"
              },
              "city": {
                "fips_place_code": "51000",
                "fips_state_code": "36",
                "latitude": "40.71230000",
                "longitude": "-74.00170000",
                "name": "New York"
              },
              "county": null
            },
            "homicide": {
              "black_murders_solved": 576,
              "black_murders_unsolved": 450,
              "hispanic_murders_solved": 321,
              "hispanic_murders_unsolved": 131,
              "homicides_reported": 1942,
              "homicides_solved": 1476,
              "white_murders_solved": 111,
              "white_murders_unsolved": 29
            },
            "jail": {
              "avg_daily_jail_population": 8223,
              "black_jail_population": 4327,
              "drug_ice_transfers": null,
              "hispanic_jail_population": 2691,
              "ice_holds": 99,
              "jail_deaths_homicide": null,
              "jail_deaths_investigating": null,
              "jail_deaths_other": null,
              "jail_deaths_suicide": null,
              "misdemeanor_jail_population": 1081,
              "other_ice_transfers": null,
              "other_jail_population": 459,
              "total_jail_population": 8129,
              "unconvicted_jail_population": 5998,
              "violent_ice_transfers": null,
              "white_jail_population": 652
            },
            "police_accountability": {
              "civilian_complaints_reported": 13516,
              "civilian_complaints_sustained": 826,
              "complaints_in_detention_reported": null,
              "complaints_in_detention_sustained": null,
              "criminal_complaints_reported": 0,
              "criminal_complaints_sustained": 0,
              "discrimination_complaints_reported": 1497,
              "discrimination_complaints_sustained": 0,
              "use_of_force_complaints_reported": 10732,
              "use_of_force_complaints_sustained": 235
            },
            "police_funding": {
              "health_budget": 1408944000,
              "housing_budget": 4269824000,
              "police_budget": 5423434000,
              "total_budget": 84986893000
            },
            "police_violence": {
              "all_deadly_force_incidents": null,
              "armed_people_killed": 32,
              "asian_pacific_people_killed": 0,
              "black_people_killed": 48,
              "fatality_rate": null,
              "hispanic_people_killed": 10,
              "less_lethal_force_2016": null,
              "less_lethal_force_2017": 1157,
              "less_lethal_force_2018": 1285,
              "other_people_killed": 8,
              "people_killed_or_injured_armed_with_gun": null,
              "people_killed_or_injured_asian_pacific": null,
              "people_killed_or_injured_black": null,
              "people_killed_or_injured_gun_perceived": null,
              "people_killed_or_injured_hispanic": null,
              "people_killed_or_injured_other": 0,
              "people_killed_or_injured_unarmed": null,
              "people_killed_or_injured_vehicle_incident": null,
              "people_killed_or_injured_white": null,
              "police_shootings_2016": 37,
              "police_shootings_2017": 23,
              "police_shootings_2018": 17,
              "shot_first": null,
              "unarmed_people_killed": 14,
              "vehicle_people_killed": 1,
              "white_people_killed": 9
            },
            "policy": {
              "bans_chokeholds_and_strangleholds": false,
              "disqualifies_complaints": null,
              "duty_to_intervene": true,
              "erases_misconduct_records": null,
              "gives_officers_unfair_access_to_information": null,
              "has_use_of_force_continuum": true,
              "limits_oversight_discipline": null,
              "police_union_contract_link": "https://www1.nyc.gov/assets/olr/downloads/pdf/collectivebargaining/pba-nyc-moa-2012-2017.pdf",
              "policy_language_bans_chokeholds_and_strangleholds": "No.\n  Restricts chokeholds to exigent circumstances\" and does not explicitly ban strangleholds (i.e. Carotid Restraints) which do not technically put pressure on the throat or windpipe when used correctly.\n  Use of Force Policy: Members of the New York City Police Department will NOT use chokeholds. A\n  chokehold shall include, but is not limited to, any pressure to the throat or windpipe, which may prevent or hinder breathing or reduce intake of air.",
              "policy_language_disqualifies_complaints": null,
              "policy_language_duty_to_intervene": "Yes.\"Failure to intervene in the use of excessive force, or report excessive force, or failure to request or to ensure timely medical treatment for an individual is serious misconduct that may result in criminal and civil liability and will result in Department discipline, up to and including dismissal. If a member of the service becomes aware of the use of excessive force or failure to request or to ensure timely medical treatment for an individual, the member must report such misconduct to the Internal Affairs Bureau Command Center. This report can be made anonymously.\"",
              "policy_language_erases_misconduct_records": null,
              "policy_language_gives_officers_unfair_access_to_information": null,
              "policy_language_has_use_of_force_continuum": "Yes. - PG 203-12",
              "policy_language_limits_oversight_discipline": null,
              "policy_language_requires_city_pay_for_misconduct": null,
              "policy_language_requires_comprehensive_reporting": "No.\n  While new changes to NYPD use of force policy will require reporting of most interactions, they will not require reporting of all incidents where officers point their firearms at civilians or put somebody up against a wall as per http://www.nytimes.com/2015/10/01/nyregion/new-york-police-will-document-virtually-all-instances-of-force.html",
              "policy_language_requires_deescalation": "Yes. \"When appropriate and consistent with personal safety, members of the service will use de-escalation techniques to safely gain voluntary compliance from a subject to reduce or eliminate the necessity to use force.\"",
              "policy_language_requires_exhaust_other_means_before_shooting": "No. Officers not required to exhaust other reasonable means before resorting to deadly force. \"In situations in which this is not safe and/or appropriate, MOS will use only the reasonable force necessary to gain control or custody of a subject.\"",
              "policy_language_requires_warning_before_shooting": "No.",
              "policy_language_restricts_delays_interrogations": null,
              "policy_language_restricts_shooting_at_moving_vehicles": "Yes. Officers are banned from shooting at vehicles based solely on the threat of the vehicle. Discharge their firearms at or from a moving vehicle unless deadly physical force is being used against the member of the service or another person present, by means other than a moving vehicle\"",
              "policy_manual_link": "https://www1.nyc.gov/site/nypd/about/about-nypd/patrol-guide.page",
              "requires_city_pay_for_misconduct": null,
              "requires_comprehensive_reporting": false,
              "requires_deescalation": true,
              "requires_exhaust_other_means_before_shooting": false,
              "requires_warning_before_shooting": false,
              "restricts_delays_interrogations": null,
              "restricts_shooting_at_moving_vehicles": true
            },
            "report": {
              "approach_to_policing_score": 66,
              "black_deadly_force_disparity_per_arrest": 1.4,
              "black_deadly_force_disparity_per_population": 7.76,
              "black_drug_arrest_disparity": 4.8,
              "black_murder_unsolved_rate": 43.86,
              "change_approach_to_policing_score": null,
              "change_overall_score": null,
              "change_police_accountability_score": null,
              "change_police_violence_score": null,
              "complaints_sustained": 6,
              "currently_updating_union_contract": null,
              "currently_updating_use_of_force": null,
              "deadly_force_incidents_per_arrest": 0,
              "deadly_force_incidents_per_arrest_per_10k": 0,
              "grade_class": "d",
              "grade_letter": "D-",
              "grade_marker": "d-minus",
              "hispanic_deadly_force_disparity_per_population": 1.23,
              "hispanic_murder_unsolved_rate": 28.98,
              "jail_deaths_per_1k_jail_population": 0,
              "jail_incarceration_per_1k_population": 1,
              "killed_by_police_per_10k_arrests": 0.5,
              "less_lethal_force_change": 0,
              "less_lethal_per_10k_arrests": 43.2,
              "low_level_arrests_per_1k_population": 123.1,
              "overall_disparity_index": 3.1,
              "overall_score": 62,
              "percent_asian_pacific_arrests": 4.66,
              "percent_asian_pacific_islander_deadly_force": 0,
              "percent_black_arrests": 47.83,
              "percent_black_deadly_force": 64,
              "percent_complaints_in_detention_sustained": null,
              "percent_criminal_complaints_sustained": null,
              "percent_discrimination_complaints_sustained": 0,
              "percent_drug_possession_arrests": 17.11,
              "percent_health_budget": 1.66,
              "percent_hispanic_arrests": 34.03,
              "percent_hispanic_deadly_force": 13.33,
              "percent_housing_budget": 5.02,
              "percent_misdemeanor_arrests": 53.3,
              "percent_murders_solved": 76,
              "percent_other_arrests": 1.32,
              "percent_other_deadly_force": 10.67,
              "percent_police_budget": 6.38,
              "percent_police_misperceive_the_person_to_have_gun": 0,
              "percent_shot_first": 0,
              "percent_use_of_force_complaints_sustained": 2,
              "percent_used_against_people_who_were_not_armed_with_gun": 57.33,
              "percent_used_against_people_who_were_unarmed": 18.67,
              "percent_violent_crime_arrests": 8.13,
              "percent_white_arrests": 12.16,
              "percent_white_deadly_force": 12,
              "percentile_complaints_sustained": 32,
              "percentile_jail_deaths_per_1k_jail_population": null,
              "percentile_jail_incarceration_per_1k_population": 79,
              "percentile_killed_by_police": 95,
              "percentile_less_lethal_force": 82,
              "percentile_low_level_arrests_per_1k_population": 42,
              "percentile_murders_solved": 29,
              "percentile_of_murders_solved": null,
              "percentile_overall_disparity_index": 18,
              "percentile_police_spending": 5,
              "percentile_unarmed_killed_by_police": 76,
              "police_accountability_score": 22,
              "police_shootings_incidents": 77,
              "police_spending_per_resident": 636.32,
              "police_violence_score": 68,
              "times_more_misdemeanor_arrests_than_violent_crime": 6,
              "total_arrests": 1968864,
              "total_jail_deaths_2016_2018": 0,
              "total_less_lethal_force_estimated": 3663,
              "total_people_killed": 75,
              "unarmed_killed_by_police_per_10k_arrests": 0.1,
              "white_murder_unsolved_rate": 20.71
            }
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

+ Response 400 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [
            "Invalid `state` parameter"
          ],
          "field_errors": {},
          "meta": {
            "total": 0,
            "showing": 0,
            "pages": 1,
            "page": 1
          },
          "data": null,
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

# Group Scorecard GeoJSON

A Collection of Endpoints that Generate GeoJSON Map Markup

## GeoJSON Maps [/scorecard/map/{state}/{type}/{location}?format={format}]

Fetch All Departments and return via Standard API Format ( GeoJSON data will be contain in response.data )

+ Parameters
    + state (string, optional) - Two Letter State Abbreviation ( or `us` for ALL states )
    + type (string, optional) - Type of Department
        + Values:
          + `sheriff`
          + `police-department`
    + location (string, optional) - This is the `slug` version of the Location
        + Example: `new-york` if you were searching for `New York`
        + Example: `st-louis` if you were searching for `St. Louis`
    + format (string, optional) - Use `geojson` to output JUST GeoJSON
        + Values:
          + `geojson`

### All Departments [GET]

Fetch **All** Departments and return via Standard API Format ( GeoJSON data will be contain in response.data )

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "type": "FeatureCollection",
            "id": "scorecard_us",
            "features": [{
                "type": "Feature",
                "properties": {
                  "complete": false,
                  "grade": "f",
                  "name": "Abbeville",
                  "score": 33,
                  "state": "AL",
                  "type": "police-department",
                  "url": "/al/police-department/abbeville"
                },
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -85.2479,
                    31.56497
                  ]
                }
              },
              {
                "type": "Feature",
                "properties": {
                  "complete": false,
                  "grade": "f",
                  "name": "Adamsville",
                  "score": 35,
                  "state": "AL",
                  "type": "police-department",
                  "url": "/al/police-department/adamsville"
                },
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -86.95412,
                    33.59763
                  ]
                }
              },
              {
                "type": "Feature",
                "properties": {
                  "complete": false,
                  "grade": "f",
                  "name": "Alabaster",
                  "score": 43,
                  "state": "AL",
                  "type": "police-department",
                  "url": "/al/police-department/alabaster"
                },
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -86.8159,
                    33.246
                  ]
                }
              }
            ]
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

### All Police Departments [GET]

Fetch All **Police** Departments and return via Standard API Format ( GeoJSON data will be contain in response.data )

+ Parameters
    + state: `us` (string, required)
    + type: `police-department` (string, required)

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "type": "FeatureCollection",
            "id": "scorecard_us_police-department",
            "features": [{
                "type": "Feature",
                "properties": {
                  "complete": false,
                  "grade": "f",
                  "name": "Abbeville",
                  "score": 33,
                  "state": "AL",
                  "type": "police-department",
                  "url": "/al/police-department/abbeville"
                },
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -85.2479,
                    31.56497
                  ]
                }
              },
              {
                "type": "Feature",
                "properties": {
                  "complete": false,
                  "grade": "f",
                  "name": "Adamsville",
                  "score": 35,
                  "state": "AL",
                  "type": "police-department",
                  "url": "/al/police-department/adamsville"
                },
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -86.95412,
                    33.59763
                  ]
                }
              },
              {
                "type": "Feature",
                "properties": {
                  "complete": false,
                  "grade": "f",
                  "name": "Alabaster",
                  "score": 43,
                  "state": "AL",
                  "type": "police-department",
                  "url": "/al/police-department/alabaster"
                },
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -86.8159,
                    33.246
                  ]
                }
              }
            ]
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

### All Sheriff Departments [GET]

Fetch All **Sheriff** Departments and return via Standard API Format ( GeoJSON data will be contain in response.data )

+ Parameters
    + state: `us` (string, required)
    + type: `sheriff` (string, required)

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "type": "FeatureCollection",
            "id": "scorecard_us_sheriff",
            "features": [{
                "type": "Feature",
                "properties": {
                  "complete": false,
                  "fips": "01001",
                  "grade": "f",
                  "name": "Autauga",
                  "score": 46,
                  "state": "AL",
                  "type": "sheriff",
                  "url": "/al/sheriff/autauga"
                }
              },
              {
                "type": "Feature",
                "properties": {
                  "complete": false,
                  "fips": "01003",
                  "grade": "f",
                  "name": "Baldwin",
                  "score": 40,
                  "state": "AL",
                  "type": "sheriff",
                  "url": "/al/sheriff/baldwin"
                }
              },
              {
                "type": "Feature",
                "properties": {
                  "complete": false,
                  "fips": "01005",
                  "grade": "f",
                  "name": "Barbour",
                  "score": 36,
                  "state": "AL",
                  "type": "sheriff",
                  "url": "/al/sheriff/barbour"
                }
              }
            ]
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

### California Departments [GET]

Fetch All **California** Departments and return via Standard API Format ( GeoJSON data will be contain in response.data )

+ Parameters
    + state: `ca` (string, required)

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "type": "FeatureCollection",
            "id": "scorecard_ca",
            "features": [{
                "type": "Feature",
                "properties": {
                  "complete": false,
                  "grade": "f",
                  "name": "Adelanto",
                  "score": 52,
                  "state": "CA",
                  "type": "police-department",
                  "url": "/ca/police-department/adelanto"
                },
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -117.4173,
                    34.5159
                  ]
                }
              },
              {
                "type": "Feature",
                "properties": {
                  "complete": false,
                  "grade": "f",
                  "name": "Agoura Hills",
                  "score": 52,
                  "state": "CA",
                  "type": "police-department",
                  "url": "/ca/police-department/agoura-hills"
                },
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -118.1291,
                    34.0617
                  ]
                }
              },
              {
                "type": "Feature",
                "properties": {
                  "complete": true,
                  "grade": "f",
                  "name": "Alameda",
                  "score": 50,
                  "state": "CA",
                  "type": "police-department",
                  "url": "/ca/police-department/alameda"
                },
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.2428,
                    37.767
                  ]
                }
              }
            ]
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

### California Police Departments [GET]

Fetch All **California Police** Departments and return via Standard API Format ( GeoJSON data will be contain in response.data )

+ Parameters
    + state: `ca` (string, required)
    + type: `police-department` (string, required)

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "type": "FeatureCollection",
            "id": "scorecard_ca_police-department",
            "features": [{
                "type": "Feature",
                "properties": {
                  "complete": false,
                  "grade": "f",
                  "name": "Adelanto",
                  "score": 52,
                  "state": "CA",
                  "type": "police-department",
                  "url": "/ca/police-department/adelanto"
                },
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -117.4173,
                    34.5159
                  ]
                }
              },
              {
                "type": "Feature",
                "properties": {
                  "complete": false,
                  "grade": "f",
                  "name": "Agoura Hills",
                  "score": 52,
                  "state": "CA",
                  "type": "police-department",
                  "url": "/ca/police-department/agoura-hills"
                },
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -118.1291,
                    34.0617
                  ]
                }
              },
              {
                "type": "Feature",
                "properties": {
                  "complete": true,
                  "grade": "f",
                  "name": "Alameda",
                  "score": 50,
                  "state": "CA",
                  "type": "police-department",
                  "url": "/ca/police-department/alameda"
                },
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.2428,
                    37.767
                  ]
                }
              }
            ]
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

### California Sheriff Departments [GET]

Fetch All **California Sheriff** Departments and return via Standard API Format ( GeoJSON data will be contain in response.data )

+ Parameters
    + state: `ca` (string, required)
    + type: `sheriff` (string, required)

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "type": "FeatureCollection",
            "id": "scorecard_ca_sheriff",
            "features": [{
                "type": "Feature",
                "properties": {
                  "complete": true,
                  "fips": "06001",
                  "grade": "f",
                  "name": "Alameda",
                  "score": 55,
                  "state": "CA",
                  "type": "sheriff",
                  "url": "/ca/sheriff/alameda"
                }
              },
              {
                "type": "Feature",
                "properties": {
                  "complete": true,
                  "fips": "06003",
                  "grade": "f",
                  "name": "Alpine",
                  "score": 46,
                  "state": "CA",
                  "type": "sheriff",
                  "url": "/ca/sheriff/alpine"
                }
              },
              {
                "type": "Feature",
                "properties": {
                  "complete": true,
                  "fips": "06005",
                  "grade": "f",
                  "name": "Amador",
                  "score": 58,
                  "state": "CA",
                  "type": "sheriff",
                  "url": "/ca/sheriff/amador"
                }
              }
            ]
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

### Los Angeles, CA Police Department [GET]

Fetch Just the **Los Angeles, CA Police** Department and return via Standard API Format ( GeoJSON data will be contain in response.data )

+ Parameters
    + state: `ca` (string, required)
    + type: `police-department` (string, required)
    + location: `los-angeles` (string, required)

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -118.2411,
                34.0521
              ]
            },
            "id": "scorecard_ca_police-department_los-angeles",
            "properties": {
              "complete": true,
              "grade": "f",
              "name": "Los Angeles",
              "score": 40,
              "state": "CA",
              "type": "police-department",
              "url": "/ca/police-department/los-angeles"
            },
            "type": "Feature"
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

### Los Angeles, CA Sheriff Department [GET]

Fetch Just the **Los Angeles, CA Sheriff** Department and return via Standard API Format ( GeoJSON data will be contain in response.data )

+ Parameters
    + state: `ca` (string, required)
    + type: `sheriff` (string, required)
    + location: `los-angeles` (string, required)

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 1,
            "showing": 1,
            "pages": 1,
            "page": 1
          },
          "data": {
            "id": "scorecard_ca_sheriff_los-angeles",
            "properties": {
              "complete": true,
              "fips": "06037",
              "grade": "f",
              "name": "Los Angeles",
              "score": 37,
              "state": "CA",
              "type": "sheriff",
              "url": "/ca/sheriff/los-angeles"
            },
            "type": "Feature"
          },
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }

### GeoJSON Ouput Only [GET]

Sample using GeoJSON Format Option

+ Parameters
    + state: `ca` (string, required)
    + type: `sheriff` (string, required)
    + location: `los-angeles` (string, required)
    + format: `geojson` (string, required)

+ Response 200 (application/json)

        {
          "type": "Feature",
          "id": "scorecard_ca_sheriff_los-angeles",
          "properties": {
            "complete": true,
            "fips": "06037",
            "grade": "f",
            "name": "Los Angeles",
            "score": 37,
            "state": "CA",
            "type": "sheriff",
            "url": "/ca/sheriff/los-angeles"
          }
        }

# Group Geolocation

The following endpoints for accessing Geolocation Data used across the API.

## States [/geo/states]

Get a list of stated supported by our Scorecard.

### Get Supported States [GET]

+ Response 200 (application/json)

        {
          "notices": [],
          "warnings": [],
          "errors": [],
          "field_errors": {},
          "meta": {
            "total": 50,
            "showing": 50,
            "pages": 1,
            "page": 1
          },
          "data": [{
              "name": "Alabama",
              "abbr": "AL"
            },
            {
              "name": "Alaska",
              "abbr": "AK"
            },
            {
              "name": "Arizona",
              "abbr": "AZ"
            },
            {
              "name": "Arkansas",
              "abbr": "AR"
            },
            {
              "name": "California",
              "abbr": "CA"
            },
            {
              "name": "North Carolina",
              "abbr": "NC"
            },
            {
              "name": "South Carolina",
              "abbr": "SC"
            },
            {
              "name": "Colorado",
              "abbr": "CO"
            },
            {
              "name": "Connecticut",
              "abbr": "CT"
            },
            {
              "name": "North Dakota",
              "abbr": "ND"
            },
            {
              "name": "South Dakota",
              "abbr": "SD"
            },
            {
              "name": "Delaware",
              "abbr": "DE"
            },
            {
              "name": "Florida",
              "abbr": "FL"
            },
            {
              "name": "Georgia",
              "abbr": "GA"
            },
            {
              "name": "New Hampshire",
              "abbr": "NH"
            },
            {
              "name": "Hawaii",
              "abbr": "HI"
            },
            {
              "name": "Idaho",
              "abbr": "ID"
            },
            {
              "name": "Illinois",
              "abbr": "IL"
            },
            {
              "name": "Indiana",
              "abbr": "IN"
            },
            {
              "name": "Iowa",
              "abbr": "IA"
            },
            {
              "name": "Rhode Island",
              "abbr": "RI"
            },
            {
              "name": "New Jersey",
              "abbr": "NJ"
            },
            {
              "name": "Kansas",
              "abbr": "KS"
            },
            {
              "name": "Kentucky",
              "abbr": "KY"
            },
            {
              "name": "Louisiana",
              "abbr": "LA"
            },
            {
              "name": "Maine",
              "abbr": "ME"
            },
            {
              "name": "Maryland",
              "abbr": "MD"
            },
            {
              "name": "Massachusetts",
              "abbr": "MA"
            },
            {
              "name": "New Mexico",
              "abbr": "NM"
            },
            {
              "name": "Michigan",
              "abbr": "MI"
            },
            {
              "name": "Minnesota",
              "abbr": "MN"
            },
            {
              "name": "Mississippi",
              "abbr": "MS"
            },
            {
              "name": "Missouri",
              "abbr": "MO"
            },
            {
              "name": "Montana",
              "abbr": "MT"
            },
            {
              "name": "Nebraska",
              "abbr": "NE"
            },
            {
              "name": "Nevada",
              "abbr": "NV"
            },
            {
              "name": "New York",
              "abbr": "NY"
            },
            {
              "name": "Ohio",
              "abbr": "OH"
            },
            {
              "name": "Oklahoma",
              "abbr": "OK"
            },
            {
              "name": "Oregon",
              "abbr": "OR"
            },
            {
              "name": "Pennsylvania",
              "abbr": "PA"
            },
            {
              "name": "Tennessee",
              "abbr": "TN"
            },
            {
              "name": "Texas",
              "abbr": "TX"
            },
            {
              "name": "Utah",
              "abbr": "UT"
            },
            {
              "name": "Vermont",
              "abbr": "VT"
            },
            {
              "name": "Virginia",
              "abbr": "VA"
            },
            {
              "name": "West Virginia",
              "abbr": "WV"
            },
            {
              "name": "Washington",
              "abbr": "WA"
            },
            {
              "name": "Wisconsin",
              "abbr": "WI"
            },
            {
              "name": "Wyoming",
              "abbr": "WY"
            }
          ],
          "attribution": {
            "text": "Data Provided by Police Scorecard",
            "website": "https://policescorecard.org",
            "link": "<a href=\"https://policescorecard.org\">Data Provided by Police Scorecard</a>",
            "license": "https://raw.githubusercontent.com/policescorecard/api/master/LICENSE",
            "report_bug": "https://github.com/policescorecard/api/issues/new",
            "logo": "https://cdn.policescorecard.org/common/logo.png",
            "icon": "https://cdn.policescorecard.org/common/icon.png"
          }
        }