Sign in
latestOpenAPI 3.1.02026-08-1013317298.0 KB

d94e0e0f1821

Places

List places with filters

Retrieve a paginated list of places (scenes) in Genesis City with extensive filtering and sorting options.

Common Use Cases:

  • Get most popular places: ?order_by=like_score&limit=20
  • Search by name: ?search=casino
  • Find places at coordinates: ?positions=-23,-96
  • Get user's favorites: ?only_favorites=true (requires auth)

Performance Tips:

  • Use pagination (limit/offset) for large result sets
  • Cache results when possible
  • Use with_realms_detail=true only when you need real-time user counts
get/places

Query parameters

limitinteger

Maximum number of places to return (max 100)

offsetinteger

Number of places to skip for pagination

positionsstring[]

Filter by specific parcel coordinates. Format: "x,y" (e.g., "-23,-96"). Can specify multiple positions to get places at any of those coordinates.

only_favoritesboolean

Show only the authenticated user's favorite places. Requires authentication. Returns empty list if not authenticated.

only_highlightedboolean

Show only places marked as highlighted by moderators

order_by'like_score' | 'most_active' | 'updated_at' | 'created_at' | 'user_visits'

Sort places by this field:

  • like_score: VP-weighted like ratio (default, best quality)
  • most_active: Current user count (trending now)
  • updated_at: Recently updated content
  • created_at: Newly created places
  • user_visits: Most visited in last 30 days
order'asc' | 'desc'

Sort direction (ascending or descending)

with_realms_detailboolean

Include real-time realm and user count details. Experimental feature. Adds realms_detail array with per-realm user counts and active parcels. Note: Slightly slower response time.

searchstring

Full-text search in place title, description, and owner. Minimum 3 characters required. Returns empty array if too short.

categoriesstring[]

Filter by categories (e.g., "art-gallery", "social", "game"). Get available categories from /categories endpoint. Multiple categories return places matching ANY category (OR logic).

ownerstring

Filter by owner's Ethereum address (case-insensitive). Must be a valid Ethereum address format.

sdkstring

Filter by SDK version (major version matching). Matches exact version or any version starting with the given prefix. Example: sdk=7 matches "7", "7.0.0", "7.3.27", etc. Places with null SDK values are treated as SDK6 (legacy scenes). Use 6 for SDK6/legacy scenes (including null), 7 for SDK7 scenes.

Response

Successfully retrieved places

okboolean
totalinteger

Total number of places matching the query (for pagination)