AlgoSeek

AlgoSeek DataGroup API

The DataGroup API from AlgoSeek — 5 operation(s) for datagroup.

GitHub OpenAPI

Documentation

📖
Documentation
https://metadata-services.algoseek.com/docs

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/algoseek/refs/heads/main/openapi/algoseek-datagroup-api-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/algoseek/refs/heads/main/overlays/algoseek-datagroup-api-overlay.yaml

OpenAPI Specification

algoseek-datagroup-api-openapi.yml Raw ↑ 
openapi: 3.0.2
info:
  title: metadata-api AWSAccount DataGroup API
  version: '1.2'
tags:
- name: DataGroup
paths:
  /api/v1/internal/data_group/:
    get:
      tags:
      - DataGroup
      summary: List Data Group
      description: Get a list of all data groups
      operationId: get_data_groups_internal_api_v1_internal_data_group__get
      parameters:
      - required: false
        schema:
          title: Is Active
          type: boolean
        name: is_active
        in: query
      - required: false
        schema:
          title: Is Public
          type: boolean
        name: is_public
        in: query
      - required: false
        schema:
          title: Status Id
          type: integer
        name: status_id
        in: query
      - required: false
        schema:
          title: Region Id
          type: integer
        name: region_id
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Get Data Groups Internal Api V1 Internal Data Group  Get
                type: array
                items:
                  $ref: '#/components/schemas/DataGroupOutAdmin'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    post:
      tags:
      - DataGroup
      summary: Add Data Group
      description: Add a new data group
      operationId: create_data_group_api_v1_internal_data_group__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataGroupCreate'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataGroupOutAdmin'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/internal/data_group/{data_group_id}/:
    get:
      tags:
      - DataGroup
      summary: Get Data Group
      description: Get Data Group details by id
      operationId: get_data_group_internal_api_v1_internal_data_group__data_group_id___get
      parameters:
      - required: true
        schema:
          title: Data Group Id
          type: integer
        name: data_group_id
        in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataGroupOutAdmin'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    put:
      tags:
      - DataGroup
      summary: Update data group
      description: Update data group details by id
      operationId: update_data_group_api_v1_internal_data_group__data_group_id___put
      parameters:
      - required: true
        schema:
          title: Data Group Id
          type: integer
        name: data_group_id
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataGroupUpdate'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataGroupOutAdmin'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    delete:
      tags:
      - DataGroup
      summary: Delete data group
      description: Delete a data group record
      operationId: delete_data_group_api_v1_internal_data_group__data_group_id___delete
      parameters:
      - required: true
        schema:
          title: Data Group Id
          type: integer
        name: data_group_id
        in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataGroupOutAdmin'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/internal/data_group/ext/{data_group_id}/:
    get:
      tags:
      - DataGroup
      summary: Get Extended Data Group
      description: Get Extended Data Group details by id
      operationId: get_ext_data_group_internal_api_v1_internal_data_group_ext__data_group_id___get
      parameters:
      - required: true
        schema:
          title: Data Group Id
          type: integer
        name: data_group_id
        in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtDataGroupOutAdmin'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/public/data_group/{data_group_id}/:
    get:
      tags:
      - DataGroup
      summary: Get Data Group
      description: Get Data Group details by id
      operationId: get_data_group_public_api_v1_public_data_group__data_group_id___get
      parameters:
      - required: true
        schema:
          title: Data Group Id
          type: integer
        name: data_group_id
        in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataGroupOutPublic'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/public/data_group/:
    get:
      tags:
      - DataGroup
      summary: List Data Groups
      description: Get a list of all data groups
      operationId: get_data_groups_public_api_v1_public_data_group__get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Get Data Groups Public Api V1 Public Data Group  Get
                type: array
                items:
                  $ref: '#/components/schemas/DataGroupOutPublic'
      security:
      - HTTPBearer: []
components:
  schemas:
    DataGroupOutAdmin:
      title: DataGroupOutAdmin
      required:
      - text_id
      - status_id
      - region_id
      - pricing_id
      - internal_name
      - is_active
      - is_public
      - id
      - created
      - modified
      type: object
      properties:
        text_id:
          title: Text Id
          type: string
        display_name:
          title: Display Name
          type: string
        full_name:
          title: Full Name
          type: string
        description:
          title: Description
          type: string
        universe_size:
          title: Universe Size
          type: integer
        universe_description:
          title: Universe Description
          type: string
        universe_components:
          title: Universe Components
          type: array
          items:
            type: string
        symbols_per_component:
          title: Symbols Per Component
          type: array
          items:
            type: integer
        tags:
          title: Tags
          type: array
          items:
            type: string
        status_id:
          title: Status Id
          type: integer
        region_id:
          title: Region Id
          type: integer
        pricing_id:
          title: Pricing Id
          type: integer
        internal_name:
          title: Internal Name
          type: string
        is_active:
          title: Is Active
          type: boolean
        is_public:
          title: Is Public
          type: boolean
        notes:
          title: Notes
          type: string
        id:
          title: Id
          type: integer
        created:
          title: Created
          type: string
          format: date-time
        modified:
          title: Modified
          type: string
          format: date-time
    DataGroupUpdate:
      title: DataGroupUpdate
      type: object
      properties:
        text_id:
          title: Text Id
          type: string
        display_name:
          title: Display Name
          type: string
        full_name:
          title: Full Name
          type: string
        description:
          title: Description
          type: string
        universe_size:
          title: Universe Size
          type: integer
        universe_description:
          title: Universe Description
          type: string
        universe_components:
          title: Universe Components
          type: array
          items:
            type: string
        symbols_per_component:
          title: Symbols Per Component
          type: array
          items:
            type: integer
        tags:
          title: Tags
          type: array
          items:
            type: string
        status_id:
          title: Status Id
          type: integer
        region_id:
          title: Region Id
          type: integer
        pricing_id:
          title: Pricing Id
          type: integer
        internal_name:
          title: Internal Name
          type: string
        is_active:
          title: Is Active
          type: boolean
        is_public:
          title: Is Public
          type: boolean
        notes:
          title: Notes
          type: string
    ValidationError:
      title: ValidationError
      required:
      - loc
      - msg
      - type
      type: object
      properties:
        loc:
          title: Location
          type: array
          items:
            anyOf:
            - type: string
            - type: integer
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
    ExtDataGroupOutAdmin:
      title: ExtDataGroupOutAdmin
      required:
      - text_id
      - status
      - region
      - pricing
      - id
      - internal_name
      - is_active
      - is_public
      - created
      - modified
      type: object
      properties:
        text_id:
          title: Text Id
          type: string
        display_name:
          title: Display Name
          type: string
        full_name:
          title: Full Name
          type: string
        description:
          title: Description
          type: string
        universe_size:
          title: Universe Size
          type: integer
        universe_description:
          title: Universe Description
          type: string
        universe_components:
          title: Universe Components
          type: array
          items:
            type: string
        symbols_per_component:
          title: Symbols Per Component
          type: array
          items:
            type: integer
        tags:
          title: Tags
          type: array
          items:
            type: string
        status:
          $ref: '#/components/schemas/EnumOutAdmin'
        region:
          $ref: '#/components/schemas/EnumOutAdmin'
        pricing:
          $ref: '#/components/schemas/DataGroupPricingOutAdmin'
        id:
          title: Id
          type: integer
        internal_name:
          title: Internal Name
          type: string
        is_active:
          title: Is Active
          type: boolean
        is_public:
          title: Is Public
          type: boolean
        notes:
          title: Notes
          type: string
        created:
          title: Created
          type: string
          format: date-time
        modified:
          title: Modified
          type: string
          format: date-time
    DataGroupCreate:
      title: DataGroupCreate
      required:
      - text_id
      - status_id
      - region_id
      - pricing_id
      - internal_name
      type: object
      properties:
        text_id:
          title: Text Id
          type: string
        display_name:
          title: Display Name
          type: string
        full_name:
          title: Full Name
          type: string
        description:
          title: Description
          type: string
        universe_size:
          title: Universe Size
          type: integer
        universe_description:
          title: Universe Description
          type: string
        universe_components:
          title: Universe Components
          type: array
          items:
            type: string
        symbols_per_component:
          title: Symbols Per Component
          type: array
          items:
            type: integer
        tags:
          title: Tags
          type: array
          items:
            type: string
        status_id:
          title: Status Id
          type: integer
        region_id:
          title: Region Id
          type: integer
        pricing_id:
          title: Pricing Id
          type: integer
        internal_name:
          title: Internal Name
          type: string
        is_active:
          title: Is Active
          type: boolean
        is_public:
          title: Is Public
          type: boolean
        notes:
          title: Notes
          type: string
    DataGroupPricingOutAdmin:
      title: DataGroupPricingOutAdmin
      required:
      - name
      - is_active
      - is_public
      - id
      - created
      - modified
      type: object
      properties:
        name:
          title: Name
          type: string
        buy_annual_decrease_factor:
          title: Buy Annual Decrease Factor
          type: number
        buy_prod_upd_factor:
          title: Buy Prod Upd Factor
          type: number
        buy_research_upd_factor:
          title: Buy Research Upd Factor
          type: number
        lease_hist_factor:
          title: Lease Hist Factor
          type: number
        lease_upd_factor:
          title: Lease Upd Factor
          type: number
        is_active:
          title: Is Active
          type: boolean
        is_public:
          title: Is Public
          type: boolean
        notes:
          title: Notes
          type: string
        id:
          title: Id
          type: integer
        created:
          title: Created
          type: string
          format: date-time
        modified:
          title: Modified
          type: string
          format: date-time
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      properties:
        detail:
          title: Detail
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    DataGroupOutPublic:
      title: DataGroupOutPublic
      required:
      - text_id
      - status_id
      - region_id
      - pricing_id
      - id
      type: object
      properties:
        text_id:
          title: Text Id
          type: string
        display_name:
          title: Display Name
          type: string
        full_name:
          title: Full Name
          type: string
        description:
          title: Description
          type: string
        universe_size:
          title: Universe Size
          type: integer
        universe_description:
          title: Universe Description
          type: string
        universe_components:
          title: Universe Components
          type: array
          items:
            type: string
        symbols_per_component:
          title: Symbols Per Component
          type: array
          items:
            type: integer
        tags:
          title: Tags
          type: array
          items:
            type: string
        status_id:
          title: Status Id
          type: integer
        region_id:
          title: Region Id
          type: integer
        pricing_id:
          title: Pricing Id
          type: integer
        id:
          title: Id
          type: integer
    EnumOutAdmin:
      title: EnumOutAdmin
      required:
      - text_id
      - internal_name
      - is_active
      - is_public
      - id
      - created
      - modified
      type: object
      properties:
        text_id:
          title: Text Id
          type: string
        display_name:
          title: Display Name
          type: string
        full_name:
          title: Full Name
          type: string
        description:
          title: Description
          type: string
        internal_name:
          title: Internal Name
          type: string
        is_active:
          title: Is Active
          type: boolean
        is_public:
          title: Is Public
          type: boolean
        notes:
          title: Notes
          type: string
        id:
          title: Id
          type: integer
        created:
          title: Created
          type: string
          format: date-time
        modified:
          title: Modified
          type: string
          format: date-time
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer