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

# Track local keywords at a location

> Up to 10 per location — each is a search per grid cell. A first check of the keywords added is queued at once; the location's others are not searched again. Keywords add no location.



## OpenAPI

````yaml https://api.surnex.io/docs/openapi.json post /v1/projects/{projectId}/local/keywords
openapi: 3.1.0
info:
  title: Surnex API
  version: 1.0.0
  description: >-
    The SEO platform's API.


    **The API is the product.** The dashboard is one client and the MCP server
    at `/mcp` is another. If a number needs deriving, a service derives it —
    never a React component, or the two clients drift.


    **Two kinds of auth.** The dashboard sends a Supabase access token as a
    Bearer JWT. MCP agents send `X-API-Key`, and the organization is resolved
    from the key.


    **Two data modes.** SERP results and Google Trends are fetched live on
    request. Everything else is written by the worker and read from Postgres, so
    a freshly-created project returns empty until its jobs complete.
servers:
  - url: https://api.surnex.io
    description: Surnex API
security: []
paths:
  /v1/projects/{projectId}/local/keywords:
    post:
      tags:
        - local-seo
      summary: Track local keywords at a location
      description: >-
        Up to 10 per location — each is a search per grid cell. A first check of
        the keywords added is queued at once; the location's others are not
        searched again. Keywords add no location.
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: projectId
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                place_id:
                  type: string
                  format: uuid
                keywords:
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 200
                  minItems: 1
                  maxItems: 10
              required:
                - place_id
                - keywords
      responses:
        '201':
          description: Added
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    nullable: true
                    properties:
                      added:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              format: uuid
                            place_id:
                              type: string
                              format: uuid
                            keyword:
                              type: string
                            location_code:
                              type: integer
                            language_code:
                              type: string
                            is_active:
                              type: boolean
                            last_checked_at:
                              type: string
                              nullable: true
                              format: date-time
                            created_at:
                              type: string
                              format: date-time
                            grid:
                              type: object
                              nullable: true
                              properties:
                                tracked_date:
                                  type: string
                                  format: date
                                cells:
                                  type: integer
                                found:
                                  type: integer
                                top3:
                                  type: integer
                                top3_share:
                                  type: number
                                average_position:
                                  type: number
                                  nullable: true
                              required:
                                - tracked_date
                                - cells
                                - found
                                - top3
                                - top3_share
                                - average_position
                          required:
                            - id
                            - place_id
                            - keyword
                            - location_code
                            - language_code
                            - is_active
                            - last_checked_at
                            - created_at
                            - grid
                      skipped:
                        type: array
                        items:
                          type: string
                    required:
                      - added
                      - skipped
                required:
                  - success
                  - data
        '400':
          description: The location would pass 10 keywords
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '402':
          description: No active plan
          content:
            application/json:
              schema:
                type: object
                properties: {}

````

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