Skip to content

List cities​

GET
/cities

Every city with a verified Fundly or a donor, not hidden by staff. Cities below the page threshold are included with has_page: false (show them as plain text). totals are platform-wide and ignore q and area. near_you is the nearest city with a page within 100 miles of near, else of the signed-in viewer's profile city, else of the edge's viewer location headers when present; null otherwise. Authentication is optional and only feeds near_you.

Authorizations​

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)
or

Parameters​

Query Parameters

q

Matches the city name or its metro's name.

Type
string
sort

active: featured first, then live Fundlies, donors, raised. az: by name.

Type
string
Valid values
"active""az"
Default
"active"
area
Type
string
Valid values
"all""us""intl"
Default
"all"
near

A lat,lng point for near_you.

Type
string
Example"38.58,-121.49"
limit
Type
integer
Minimum
1
Maximum
500
Default
24
offset
Type
integer
Minimum
0
Default
0

Responses​

One page of cities

application/json
JSON
{
"data": [
],
"total": 0,
"totals": {
"cities": 0,
"us_cities": 0,
"countries": 0,
"us_states": 0,
"fundlies": 0,
"fundly_cities": 0,
"raised_cents": 0,
"donors": 0
},
"near_you": {
"slug": "sacramento-ca",
"name": "Sacramento",
"region": "CA",
"country": "US",
"label": "Sacramento, CA",
"photo_url": "string",
"lat": 0,
"lng": 0,
"fundlies_active": 0,
"fundlies_funded": 0,
"donors": 0,
"raised_cents": 0,
"has_page": true,
"metro": {
"slug": "string",
"name": "string"
}
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress