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

# Snapshot a competitor or adjacent company

> What they do, growth signals, and recent funding/news -- useful standalone, or as input to search_investors's include_competitor_lookalikes. Costs 10 credit(s) per call, charged even on a miss.



## OpenAPI

````yaml /helium/openapi.json post /v1/fundraising/research-company
openapi: 3.1.0
info:
  title: Helium API
  version: '1.0'
  description: >-
    Helium is a fundraising-research REST API sharing Horizon's prepaid-credit
    account system. Every request authenticates with an `Authorization: Bearer
    <key>` header (the same key that works against Horizon) and, on a billed
    endpoint, debits a fixed number of credits from your shared prepaid balance.
    Check your balance any time with GET /v1/usage (shared with Horizon).
servers:
  - url: https://lite.gravitygtm.com/api
security:
  - bearerAuth: []
paths:
  /v1/fundraising/research-company:
    post:
      tags:
        - fundraising
      summary: Snapshot a competitor or adjacent company
      description: >-
        What they do, growth signals, and recent funding/news -- useful
        standalone, or as input to search_investors's
        include_competitor_lookalikes. Costs 10 credit(s) per call, charged even
        on a miss.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResearchCompanyRequest'
      responses:
        '200':
          description: >-
            200 -- success. Charges 10 credit(s) on this endpoint. cached is
            always false today -- no Helium endpoint is currently cached.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      company:
                        type: object
                        properties:
                          name:
                            type: string
                          website:
                            type: string
                          linkedinUrl:
                            type: string
                          description:
                            type: string
                          employeeCount:
                            type: number
                        additionalProperties: true
                      news:
                        type: array
                        items:
                          type: object
                          properties:
                            title:
                              type: string
                            url:
                              type: string
                            snippet:
                              type: string
                          additionalProperties: true
                    additionalProperties: true
                    description: Company snapshot plus recent funding/news web-search hits.
                  credits_charged:
                    type: number
                    description: 10 credit(s), charged even on a miss.
                  credits_remaining:
                    type: number
                  cached:
                    type: boolean
                    description: >-
                      Always false today -- no Helium endpoint is currently
                      cached.
                  request_id:
                    type: string
                    format: uuid
                required:
                  - data
                  - credits_charged
                  - credits_remaining
                  - cached
                  - request_id
        '401':
          description: >-
            401 unauthorized -- missing or invalid `Authorization: Bearer <key>`
            header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: >-
            402 insufficient_credits -- not enough credit balance to cover this
            endpoint's price. The vendor is never called.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: >-
            422 not_found -- the vendor was called successfully but returned no
            result. Still charged at full price.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - type: object
                    properties:
                      credits_charged:
                        type: number
                        description: >-
                          Full listed price -- every Helium billed endpoint
                          charges on a miss.
        '429':
          description: 429 rate_limited -- per-key fixed-window rate limit exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '502':
          description: >-
            502 vendor_error -- the upstream vendor call failed or threw. Any
            reserved credits are refunded in full.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: >-
            503 vendor_capacity -- this endpoint's vendor has hit its global
            daily spend cap. No credits are reserved; try again later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ResearchCompanyRequest:
      type: object
      properties:
        company_linkedin_url:
          type: string
          format: uri
        company_name:
          type: string
          minLength: 1
        domain:
          type: string
          minLength: 1
    ErrorResponse:
      type: object
      description: >-
        Standard error body. Every response (success or error) carries a
        request_id for support reference.
      properties:
        error:
          type: string
          description: Machine-readable error code.
          enum:
            - unauthorized
            - insufficient_credits
            - not_found
            - rate_limited
            - vendor_error
            - vendor_capacity
        message:
          type: string
          description: Human-readable error detail.
        request_id:
          type: string
          format: uuid
        credits_remaining:
          type: number
          description: >-
            Present whenever a post-reservation/refund balance is known for this
            request.
        refund_issue:
          type: boolean
          description: >-
            Set only when a compensating credit refund itself failed (e.g. a
            transient store error) -- the customer may have been charged without
            the refund landing yet.
      required:
        - error
        - message
        - request_id
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````