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

# Create a watchlist

> Create a watchlist from a name and a list of items.

`name` and `items` are required. Duplicate items are removed and the response returns the items sorted. You can own up to 300 watchlists.



## OpenAPI

````yaml /api-rest/openapi/openapi_watchlists.json post /v1/watchlists
openapi: 3.1.0
info:
  title: Bigdata Watchlists API
  version: 1.0.0
  description: >-
    Create and manage watchlists: named lists of entities that you can reuse
    across Bigdata, for example to focus a search on a group of companies.
servers:
  - url: https://api.bigdata.com
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Watchlists
    description: Create, read, update, delete, and list watchlists.
paths:
  /v1/watchlists:
    post:
      tags:
        - Watchlists
      summary: Create a watchlist
      description: >-
        Create a watchlist from a name and a list of items.


        `name` and `items` are required. Duplicate items are removed and the
        response returns the items sorted. You can own up to 300 watchlists.
      operationId: createWatchlist
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WatchlistCreate'
            examples:
              basic:
                summary: Basic watchlist
                value:
                  name: MAMAA stocks
                  description: Large-cap US technology companies
                  items:
                    - 0157B1
                    - 12E454
                    - 228D42
                    - 4A6F00
                    - D8442A
      responses:
        '200':
          description: The watchlist was created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WatchlistResponse'
              example:
                metadata:
                  request_id: 9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4
                  timestamp: '2026-10-23T09:00:00Z'
                results:
                  id: b548fc37-87d3-4bc7-b482-eeeeb7060f78
                  user_id: A1B2C3D4E5
                  created_at: '2026-10-20T10:15:00.000000Z'
                  updated_at: '2026-10-23T08:30:00.000000Z'
                  interacted_at: null
                  name: MAMAA stocks
                  description: Large-cap US technology companies
                  items:
                    - 0157B1
                    - 12E454
                    - 228D42
                    - 4A6F00
                    - D8442A
        '400':
          description: >-
            The request is invalid: an unknown field, a wrong type, a missing
            required field, or a value out of range. The message is always
            `Invalid payload`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errors:
                  - message: Invalid payload
                metadata:
                  request_id: 9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4
                  timestamp: '2026-10-23T09:00:00Z'
        '401':
          description: An API key is required, or the key is not valid.
        '403':
          description: >-
            The API key does not have access to Watchlists, or the action is not
            allowed (for example, you already own the maximum of 300
            watchlists).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errors:
                  - message: Forbidden
                metadata:
                  request_id: 9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4
                  timestamp: '2026-10-23T09:00:00Z'
        '409':
          description: The request conflicts with the current state of the watchlist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errors:
                  - message: Conflict
                metadata:
                  request_id: 9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4
                  timestamp: '2026-10-23T09:00:00Z'
        '422':
          description: The request is well formed but cannot be processed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errors:
                  - message: Unprocessable Entity
                metadata:
                  request_id: 9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4
                  timestamp: '2026-10-23T09:00:00Z'
        '500':
          description: >-
            An unexpected error occurred. Retry the request. If it persists,
            contact support with the `request_id`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errors:
                  - message: Internal Server Error
                metadata:
                  request_id: 9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4
                  timestamp: '2026-10-23T09:00:00Z'
components:
  schemas:
    WatchlistCreate:
      type: object
      additionalProperties: false
      required:
        - name
        - items
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
          description: Name of the watchlist.
        items:
          type: array
          maxItems: 2000
          items:
            type: string
          description: >-
            Ids of the entities in the watchlist. Duplicates are removed. A
            watchlist holds at most 2000 items.
          example:
            - 0157B1
            - 12E454
            - 228D42
            - 4A6F00
            - D8442A
        description:
          type:
            - string
            - 'null'
          maxLength: 4000
          description: Free-text description.
    WatchlistResponse:
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/Metadata'
        results:
          $ref: '#/components/schemas/Watchlist'
      required:
        - metadata
        - results
    ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorEntry'
        metadata:
          $ref: '#/components/schemas/Metadata'
      required:
        - errors
    Metadata:
      type: object
      additionalProperties: false
      properties:
        request_id:
          type: string
          description: Id for this request. Include it if you contact support.
        timestamp:
          type: string
          format: date-time
      required:
        - request_id
        - timestamp
    Watchlist:
      allOf:
        - $ref: '#/components/schemas/WatchlistSummary'
        - type: object
          properties:
            items:
              type: array
              items:
                type: string
              description: Entity ids, sorted.
          required:
            - items
    ErrorEntry:
      type: object
      properties:
        message:
          type: string
          description: What went wrong.
      required:
        - message
    WatchlistSummary:
      type: object
      properties:
        id:
          type: string
        user_id:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        interacted_at:
          type:
            - string
            - 'null'
          format: date-time
        name:
          type: string
        description:
          type:
            - string
            - 'null'
      required:
        - id
        - user_id
        - created_at
        - updated_at
        - name
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: API key from the Bigdata Developer Platform.

````

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