> ## 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.

# A keyword's grid

> Every cell of one check — the newest, or `date` — with our position there and the top three, plus every check's summary for the trend.



## OpenAPI

````yaml https://api.surnex.io/docs/openapi.json get /v1/projects/{projectId}/local/keywords/{keywordId}/grid
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/{keywordId}/grid:
    get:
      tags:
        - local-seo
      summary: A keyword's grid
      description: >-
        Every cell of one check — the newest, or `date` — with our position
        there and the top three, plus every check's summary for the trend.
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: projectId
          in: path
        - schema:
            type: string
            format: uuid
          required: true
          name: keywordId
          in: path
        - schema:
            type: string
            format: date
          required: false
          name: date
          in: query
      responses:
        '200':
          description: Grid
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    nullable: true
                    properties:
                      keyword_id:
                        type: string
                        format: uuid
                      place:
                        type: object
                        nullable: true
                        properties:
                          id:
                            type: string
                            format: uuid
                          name:
                            type: string
                          business_name:
                            type: string
                            nullable: true
                          address:
                            type: string
                            nullable: true
                          cid:
                            type: string
                            nullable: true
                          latitude:
                            type: number
                            nullable: true
                          longitude:
                            type: number
                            nullable: true
                          location_code:
                            type: integer
                          language_code:
                            type: string
                          grid_size:
                            type: integer
                          spacing_km:
                            type: number
                          keyword_count:
                            type: integer
                          created_at:
                            type: string
                            format: date-time
                        required:
                          - id
                          - name
                          - business_name
                          - address
                          - cid
                          - latitude
                          - longitude
                          - location_code
                          - language_code
                          - grid_size
                          - spacing_km
                          - keyword_count
                          - created_at
                      grid_size:
                        type: integer
                      summary:
                        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
                      points:
                        type: array
                        items:
                          type: object
                          properties:
                            row:
                              type: integer
                            col:
                              type: integer
                            latitude:
                              type: number
                            longitude:
                              type: number
                            position:
                              type: integer
                              nullable: true
                            top_results:
                              type: array
                              items:
                                type: object
                                properties:
                                  position:
                                    type: integer
                                  title:
                                    type: string
                                    nullable: true
                                  domain:
                                    type: string
                                    nullable: true
                                  rating:
                                    type: number
                                    nullable: true
                                  reviews_count:
                                    type: integer
                                    nullable: true
                                  is_own:
                                    type: boolean
                                required:
                                  - position
                                  - title
                                  - domain
                                  - rating
                                  - reviews_count
                                  - is_own
                          required:
                            - row
                            - col
                            - latitude
                            - longitude
                            - position
                            - top_results
                      history:
                        type: array
                        items:
                          type: object
                          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:
                      - keyword_id
                      - place
                      - grid_size
                      - summary
                      - points
                      - history
                required:
                  - success
                  - data

````

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