# Foursquare on Onekey

> 2 endpoints for Foursquare (0 stable, 2 beta), 1 to 5 credits each. Category: Travel, local & reviews. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.

Page: https://onekey.dev/platforms/foursquare
Reference (Markdown): https://onekey.dev/docs/api/foursquare.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 2 mapped Foursquare endpoints return each:

- `entity.category` (string): 2
- `entity.description` (string): 2
- `entity.id` (string): 2
- `entity.name` (string): 2
- `entity.stats.rating` (number): 2
- `place.address` (string): 2
- `place.lat` (number): 2
- `place.lon` (number): 2
- plus 2 platform-specific fields under `ext.`

## Endpoints

### foursquare.place

One Foursquare place by fsq_id (Places API v3).
- Price: 1 credit per fresh call. Status: beta. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/foursquare/place?fsq_id=4b4d4e2af964a520e2c126e3` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `fsq_id` (string, required): Foursquare place id
- Fields returned: `entity.id`, `entity.name`, `place.address`, `entity.category`, `place.lat`, `place.lon`, `entity.stats.rating`, `entity.description`, `ext.website`, `ext.phone`
- Reference: https://onekey.dev/docs/api/foursquare/place.md

### foursquare.search

Search Foursquare places near a location (Places API v3).
- Price: 5 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/foursquare/search?q=coffee&near=San%20Francisco%2C%20CA` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search term
  - `near` (string, required): Location text, e.g. 'San Francisco, CA'
- Fields returned: `entity.id`, `entity.name`, `place.address`, `entity.category`, `place.lat`, `place.lon`, `entity.stats.rating`, `entity.description`, `ext.website`, `ext.phone`
- Reference: https://onekey.dev/docs/api/foursquare/search.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/foursquare/place?fsq_id=4b4d4e2af964a520e2c126e3" \
  -H "x-api-key: YOUR_API_KEY"
```