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

# Create a portfolio

> Creates a portfolio. A name you already use for one of your portfolios is rejected with a 409; to change that portfolio, use `PUT /portfolios/{portfolioId}`.



## OpenAPI

````yaml /api-reference/openapi-v2.json post /portfolios
openapi: 3.0.0
info:
  title: Noonum API v2
  version: 2.0.0
  contact:
    name: Noonum Support
    email: hello@noonum.com
  description: >
    Create and manage investment strategies, portfolios, and backtests. The API
    covers the full strategy lifecycle, including creation and editing, the
    archive and revive flow, version submission and run state, result companies,
    evidence, factsheets, exposures, and taxonomy.
servers:
  - url: https://api.noonum.ai/v2
security:
  - bearerAuth: []
tags:
  - name: UserStrategies
    description: Create, read, update, and manage your own investment strategies.
  - name: Helper
    description: >-
      Shared utilities for company lookup and search, objective tooling, and a
      health check.
  - name: Portfolios
    description: Create, read, update, and delete portfolios.
  - name: Backtest
    description: Run a standalone backtest on a portfolio of companies.
  - name: Segments
    description: >-
      Companies' business segments, grouped into segment groups and tagged to
      GICS, NAICS and ICB industries, and the companies most similar to a
      company by the segments they share. You read a company's segment data once
      you subscribe to the company. A subscription lasts 365 days and cannot be
      cancelled or moved to another company; your plan sets how many you can
      hold at once, and `GET /segments/subscriptions` lists them.
  - name: Usage
    description: Read your plan, your remaining credits, and your credit usage.
paths:
  /portfolios:
    post:
      tags:
        - Portfolios
      summary: Create a portfolio
      description: >-
        Creates a portfolio. A name you already use for one of your portfolios
        is rejected with a 409; to change that portfolio, use `PUT
        /portfolios/{portfolioId}`.
      operationId: app.api.v2.portfolios.post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  example: My Portfolio
                public:
                  type: boolean
                  default: false
                tags:
                  type: array
                  items:
                    type: string
                  nullable: true
                source:
                  type: string
                  nullable: true
                metadata:
                  type: object
                  nullable: true
                holdings:
                  type: array
                  items:
                    type: object
                    properties:
                      weight:
                        type: number
                        format: float
                        minimum: 0
                        maximum: 1
                      symbol:
                        type: string
                        nullable: true
                      exchange:
                        type: string
                        nullable: true
                      name:
                        type: string
                        nullable: true
                      raw_payload:
                        type: object
                        nullable: true
                      security_id:
                        type: string
                        format: uuid
                        nullable: true
                        deprecated: true
                        description: Deprecated. Accepted and ignored.
                      org_id:
                        type: string
                        format: uuid
                        nullable: true
                        description: >-
                          The company (issuer) ID, as returned by company search
                          or strategy results. Stored when it names a known
                          company and dropped otherwise; the holding is kept
                          either way.
                    required:
                      - weight
              required:
                - name
                - holdings
      responses:
        '201':
          description: A new portfolio was created.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      user_id:
                        type: string
                        nullable: true
                        description: >-
                          Owner identifier, null when the caller is not the
                          owner.
                      name:
                        type: string
                      public:
                        type: boolean
                      tags:
                        type: array
                        items:
                          type: string
                        nullable: true
                      source:
                        type: string
                        nullable: true
                      metadata:
                        type: object
                        nullable: true
                      created_at:
                        description: >-
                          Timestamp of when the portfolio was created, as an RFC
                          7231 HTTP date.
                        type: string
                        example: Sat, 05 Apr 2025 17:43:37 GMT
                      updated_at:
                        description: >-
                          Timestamp of when the portfolio was last updated, as
                          an RFC 7231 HTTP date.
                        type: string
                        example: Mon, 07 Apr 2025 18:39:41 GMT
                    required:
                      - id
                      - user_id
                      - name
                      - public
                      - created_at
                      - updated_at
                  - type: object
                    properties:
                      holdings:
                        type: array
                        items:
                          type: object
                          properties:
                            weight:
                              type: number
                              format: float
                              minimum: 0
                              maximum: 1
                            symbol:
                              type: string
                              nullable: true
                            exchange:
                              type: string
                              example: XNAS
                              nullable: true
                              description: >-
                                ISO 10383 operating market identifier code for
                                the listing exchange. Falls back to the exchange
                                string the caller supplied when the holding has
                                not been matched to a company.
                            market:
                              type: string
                              nullable: true
                            name:
                              type: string
                              nullable: true
                            raw_payload:
                              type: object
                              nullable: true
                            security_id:
                              type: string
                              format: uuid
                              nullable: true
                              deprecated: true
                              description: Deprecated. Always null.
                            org_id:
                              type: string
                              format: uuid
                              nullable: true
                              description: >-
                                The company (issuer) ID, the same ID company
                                search and strategy results return. Null when
                                the holding has not been matched to a company,
                                which is expected for cash lines, funds and
                                delisted tickers.
                            market_cap:
                              type: number
                              example: 3120000000000
                              nullable: true
                              description: >-
                                Latest market capitalisation in USD, summed over
                                the company's live share classes. Null when the
                                holding has not been matched to a company, and
                                when only some of its classes can be priced — a
                                partial sum is materially low and
                                indistinguishable from a correct one.
                            sector:
                              type: string
                              nullable: true
                            industry:
                              type: string
                              nullable: true
                            created_at:
                              description: >-
                                Timestamp of when the holding was created, as an
                                RFC 7231 HTTP date.
                              type: string
                              example: Sat, 05 Apr 2025 17:43:37 GMT
                            updated_at:
                              description: >-
                                Timestamp of when the holding was last updated,
                                as an RFC 7231 HTTP date.
                              type: string
                              example: Mon, 07 Apr 2025 18:39:41 GMT
                          required:
                            - weight
                            - created_at
                            - updated_at
                    required:
                      - holdings
        '400':
          description: The request body is invalid.
          content:
            application/json:
              schema:
                type: object
                description: A standard error response.
                properties:
                  error:
                    description: A human-readable description of the error.
                    type: string
        '409':
          description: You already have a portfolio with this name.
          content:
            application/json:
              schema:
                type: object
                description: A standard error response.
                properties:
                  error:
                    description: A human-readable description of the error.
                    type: string
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT or API Key
      description: |
        Enter 'Bearer' followed by a space and then your JWT or API Key.
        Example: `Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`
        or `Bearer YOUR_API_KEY_HERE`

````

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