> ## Documentation Index
> Fetch the complete documentation index at: https://terrascout.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List places

> The counties in the workspace's coverage, with how many datasets each
holds by topic. Places outside the coverage are not listed.




## OpenAPI

````yaml /platforms/openapi.yaml get /v1/places
openapi: 3.1.0
info:
  title: Ploti Data Feeds API
  version: 1.0.0
  description: |
    Early access: contact support@ploti.ai to set up a subscription.

    Public records from the places your workspace covers, delivered to your
    own systems. Subscribe to counties, load each dataset's snapshot once,
    then apply each new version's changes as Ploti publishes them.

    Every call acts as the workspace member who holds the API key. Lists that
    page take `limit` and `cursor` and return `nextCursor`, null on the last
    page. Fields are camelCase. A refusal is
    `{ "error": { "code", "message", "links" } }`.
servers:
  - url: https://api.ploti.ai
security:
  - bearerAuth: []
tags:
  - name: Places
    description: The counties a workspace can subscribe to.
  - name: Datasets
    description: What each dataset holds, where it comes from and how it is shaped.
  - name: Versions
    description: Each published version of a dataset, its files and its changes.
  - name: Subscriptions
    description: The places, topics and datasets you receive, and where they are delivered.
  - name: Events
    description: An ordered, replayable log of what changed in a subscription.
paths:
  /v1/places:
    get:
      tags:
        - Places
      summary: List places
      description: |
        The counties in the workspace's coverage, with how many datasets each
        holds by topic. Places outside the coverage are not listed.
      operationId: listPlaces
      parameters:
        - name: state
          in: query
          description: Two-letter state code, e.g. `FL`.
          schema:
            type: string
            pattern: ^[A-Z]{2}$
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/cursor'
      responses:
        '200':
          description: A page of places.
          content:
            application/json:
              schema:
                type: object
                required:
                  - places
                  - nextCursor
                properties:
                  places:
                    type: array
                    items:
                      $ref: '#/components/schemas/Place'
                  nextCursor:
                    $ref: '#/components/schemas/NextCursor'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    limit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 50
    cursor:
      name: cursor
      in: query
      description: The `nextCursor` of the previous page.
      schema:
        type: string
  schemas:
    Place:
      type: object
      required:
        - id
        - name
        - state
        - kind
      properties:
        id:
          type: string
          description: '`us-<state>-<FIPS>`.'
          examples:
            - us-fl-12095
        name:
          type: string
          examples:
            - Orange County
        state:
          type: string
          examples:
            - FL
        kind:
          type: string
          enum:
            - county
        datasetCounts:
          type: object
          description: Datasets by topic id.
          additionalProperties:
            type: integer
          examples:
            - permits: 6
              zoning: 3
              parcels: 1
    NextCursor:
      type:
        - string
        - 'null'
      description: Pass as `cursor` for the next page. Null on the last page.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              examples:
                - not_found
                - outside_coverage
                - not_distributable
                - cursor_expired
            message:
              type: string
            links:
              type: object
              additionalProperties:
                type: string
                format: uri
  responses:
    Unauthorized:
      description: Missing or invalid API key, or a key without the `feeds` scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key from Settings, API keys, with the `feeds` scope.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.