# Filter Ids

In the [`/v1/api/college-list`](https://docs.collegeai.com/latest/json-api/endpoints#get-a-list-of-colleges-matching-a-filter-optionally-sorted-by-a-criteria.) endpoint, we have a `filters` parameter of a JSON type. This documentation includes all the possible filters you can include in the parameter.

{% hint style="info" %}
Filter ids can be specified with camel-case or kebab-case. In this documentation, we'll be using kebab-case.
{% endhint %}

## Filters

<details>

<summary><code>name</code></summary>

College name. You may be looking to use [`/v1/api/college/info`](https://docs.collegeai.com/latest/json-api/endpoints#get-information-for-one-or-more-colleges.)

**Type**

String

**Example**

```json
{
    "name": "Stanford"
}
```

</details>

### Admissions

<details>

<summary><code>close-to-my-scores</code></summary>

Show schools with applicants with similar SAT and/or ACT scores

**Type**

Boolean

**Example**

```json
{
    "close-to-my-scores": true
}
```

</details>

<details>

<summary><code>sat-overall</code></summary>

SAT score. Best used with `close-to-my-scores`

**Type**

Number

**Example**

```json
{
    "close-to-my-scores": true,
    "sat-overall": 1220
}
```

</details>

<details>

<summary><code>act-composite</code></summary>

ACT score. Best used with `close-to-my-scores`

**Type**

Number

**Example**

```json
{
    "close-to-my-scores": true,
    "act-composite": 23
}
```

</details>

<details>

<summary><code>application-requires-gpa</code></summary>

**Type**

Boolean

**Example**

```json
{
    "application-requires-gpa": true
}
```

</details>

<details>

<summary><code>gpa-minimum-ten-percent</code></summary>

High school GPA. Returns colleges where the GPA is higher than the 10th percentile of students

**Type**

Number

**Example**

```json
{
    "gpa-minimum-ten-percent": 3.5
}
```

</details>

<details>

<summary><code>selectivity</code></summary>

**Type**

List of strings

**Options**

* `"notSelective"`
* `"lessSelective"`
* `"selective"`
* `"verySelective"`
* `"mostSelective"`

**Example**

```json
{
    "selectivity": ["notSelective", "lessSelective"]
}
```

</details>

<details>

<summary><code>show-safeties</code></summary>

Show good safety schools

**Type**

Boolean

**Example**

```json
{
    "show-safeties": true
}
```

</details>

<details>

<summary><code>show-reaches</code></summary>

Show good reach schools

**Type**

Boolean

**Example**

```json
{
    "show-reaches": true
}
```

</details>

### Type of school

<details>

<summary><code>degree-length</code></summary>

**Type**

List of strings

**Options**

* `"2year"`
* `"4year"`

**Example**

```json
{
    "degree-length": ["2year"]
}
```

</details>

<details>

<summary><code>funding-type</code></summary>

**Type**

List of strings

**Options**

* `"public"`
* `"private"`
* `"forprofit"`

**Example**

```json
{
    "funding-type": ["public", "private"]
}
```

</details>

<details>

<summary><code>school-size</code></summary>

**Type**

List of strings

**Options**

* `"small"`
* `"medium"`
* `"large"`

**Example**

```json
{
    "school-size": ["small", "medium"]
}
```

</details>

<details>

<summary><code>number-enrolled-students</code></summary>

**Type**

Range

**Example**

```json
{
    "number-enrolled-students": [0, 10000]
}
```

</details>

<details>

<summary><code>sex</code></summary>

**Type**

List of strings

**Options**

* `"coed"`
* `"women"`
* `"men"`

**Example**

```json
{
    "sex": ["coed"]
}
```

</details>

<details>

<summary><code>primary-faith</code></summary>

**Type**

String

**Options**

* `"christian"`
* `"jewish"`
* `"muslim"`
* `"buddhist"`
* `"hindu"`

**Example**

```json
{
    "primary-faith": "jewish"
}
```

</details>

### Location

<details>

<summary><code>zip-code</code></summary>

Home zip code

**Type**

String

**Example**

```json
{
    "zip-code": "94063"
}
```

</details>

<details>

<summary><code>distance-from-home-miles</code></summary>

Requires `zip-code` to be set

**Type**

Range

**Example**

```json
{
    "zip-code": "94063",
    "distance-from-home-miles": [0, 500]
}
```

</details>

<details>

<summary><code>distance-from-home-drive-time</code></summary>

Drive time in hours. Requires a `zip-code` to be set

**Type**

Range

**Example**

```json
{
    "zip-code": "94063",
    "distance-from-home-drive-time": [2, 3]
}
```

</details>

<details>

<summary><code>in-state</code></summary>

Abbreviation of the state the college is in

**Type**

String

**Example**

```json
{
    "in-state": "NY"
}
```

</details>

<details>

<summary><code>area-type</code></summary>

**Type**

List of strings

**Options**

* `"rural"`
* `"suburban"`
* `"urban"`

**Example**

```json
{
    "area-type": ["urban"]
}
```

</details>

### Sports & culture

<details>

<summary><code>min-percentage-of-minorities</code></summary>

**Type**

Number, 0 to 100

**Example**

```json
{
    "min-percentage-of-minorities": 50
}
```

</details>

<details>

<summary><code>activites</code></summary>

**Type**

List of strings

**Options**

* `"campusMinistries"`
* `"literaryMagazine"`
* `"radioStation"`
* `"choralGroups"`
* `"marchingBand"`
* `"studentGovernment"`
* `"concertBand"`
* `"modelUN"`
* `"studentNewspaper"`
* `"dance"`
* `"musicEnsembles"`
* `"studentRunFilmSociety"`
* `"dramaTheater"`
* `"musicalTheater"`
* `"symphonyOrchestra"`
* `"internationalStudentOrganization"`
* `"opera"`
* `"televisionStation"`
* `"jazzBand"`
* `"pepBand"`
* `"yearbook"`

**Example**

```json
{
    "activites": ["dance", "jazzBand", "modelUN"]
}
```

</details>

<details>

<summary><code>athletic-conference</code></summary>

**Type**

String

**Options**

* `"NCAA D1"`
* `"NCAA D2"`
* `"NCAA D3"`
* `"NCAA Associate Member"`
* `"NCAA"`
* `"NJCAA"`
* `"NJCAA D1"`
* `"NJCAA D2"`
* `"NJCAA D3"`
* `"NAIA"`
* `"NAIA D1"`
* `"NAIA D2"`
* `"NCCAA"`
* `"Independent"`
* `"CCCAA"`
* `"NWAC"`
* `"USCAA"`

**Example**

```json
{
    "athletic-conference": "NCAA D1"
}
```

</details>

### Payment

<details>

<summary><code>atleast-percent-financial-aid-met</code></summary>

Minimum percent of financial aid met

**Type**

Number, 0 to 100

**Example**

```json
{
    "atleast-percent-financial-aid-met": 40
}
```

</details>

<details>

<summary><code>max-tuition</code></summary>

**Type**

Number

**Example**

```json
{
    "max-tuition": 40000
}
```

</details>

<details>

<summary><code>max-in-state-tuition</code></summary>

Maximum in-state tuition for one year

**Type**

Number

**Example**

```json
{
    "max-in-state-tuition": 25000
}
```

</details>

<details>

<summary><code>max-out-of-state-tuition</code></summary>

Minimum out-of-state tuition for one year

**Type**

Number

**Example**

```json
{
    "max-out-of-state-tuition": 55000
}
```

</details>
