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

# Live search results

> One of only two endpoints that fetch on request. Cached for six hours — long enough to be useful, short enough that the results still mean something.



## OpenAPI

````yaml https://api.surnex.io/docs/openapi.json post /v1/keywords/serp
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/keywords/serp:
    post:
      tags:
        - keywords
      summary: Live search results
      description: >-
        One of only two endpoints that fetch on request. Cached for six hours —
        long enough to be useful, short enough that the results still mean
        something.
      parameters:
        - schema:
            type: string
            format: uuid
          required: false
          name: org_id
          in: query
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                location_code:
                  type: integer
                  default: 2840
                language_code:
                  type: string
                  default: en
                keyword:
                  type: string
                  minLength: 1
                  maxLength: 200
                depth:
                  type: integer
                  minimum: 1
                  maximum: 100
                  default: 10
                project_id:
                  type: string
                  format: uuid
              required:
                - keyword
      responses:
        '200':
          description: The results page
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    nullable: true
                    properties:
                      data:
                        type: object
                        properties:
                          keyword:
                            type: string
                          location_code:
                            type: integer
                          language_code:
                            type: string
                          results:
                            type: array
                            items:
                              type: object
                              properties:
                                position:
                                  type: integer
                                url:
                                  type: string
                                  nullable: true
                                domain:
                                  type: string
                                  nullable: true
                                title:
                                  type: string
                                  nullable: true
                                description:
                                  type: string
                                  nullable: true
                                result_type:
                                  type: string
                                breadcrumb:
                                  type: string
                                  nullable: true
                              required:
                                - position
                                - url
                                - domain
                                - title
                                - description
                                - result_type
                                - breadcrumb
                          total_results:
                            type: number
                            nullable: true
                        required:
                          - keyword
                          - location_code
                          - language_code
                          - results
                          - total_results
                      cached:
                        type: boolean
                    required:
                      - data
                      - cached
                required:
                  - success
                  - data
        '402':
          description: Monthly research lookups used up, or 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.