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

# Get tool route costs

> Read per-route pricing for one tool.



## OpenAPI

````yaml /tools-reference/openapi.json get /tools/{tool}/costs
openapi: 3.1.0
info:
  title: Osintly Tools API
  version: 1.0.0
  description: OpenAPI specification for Osintly Epic Games tools and catalog endpoints.
  contact:
    name: Osintly
    url: https://docs.osint.ly/tools-reference/introduction
servers:
  - url: https://api.osint.ly
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Tools Catalog
    description: Discover available tools, metadata, and route costs.
  - name: Epic Games
    description: Direct Epic Games account validation and enrichment endpoints.
paths:
  /tools/{tool}/costs:
    get:
      tags:
        - Tools Catalog
      summary: Get tool route costs
      description: Read per-route pricing for one tool.
      operationId: getToolCosts
      parameters:
        - $ref: '#/components/parameters/ToolPath'
      responses:
        '200':
          description: Tool route cost payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToolCostsResponse'
              example:
                defaultPrice: null
                routes:
                  - kind: free
                    method: GET
                    quantity: 0
                    routePattern: /
                  - kind: free
                    method: GET
                    quantity: 0
                    routePattern: /infos
                  - kind: free
                    method: POST
                    quantity: 0
                    routePattern: /search
                  - kind: free
                    method: POST
                    quantity: 0
                    routePattern: /suggestions
                  - kind: core_search
                    method: POST
                    quantity: 1
                    routePattern: /resolve
                  - kind: core_search
                    method: POST
                    quantity: 1
                    routePattern: /linked-accounts
                  - kind: core_search
                    method: POST
                    quantity: 1
                    routePattern: /tags
                  - kind: core_search
                    method: POST
                    quantity: 1
                    routePattern: /regions
                  - kind: core_search
                    method: POST
                    quantity: 2
                    routePattern: /friends-achievements
                  - kind: core_search
                    method: POST
                    quantity: 1
                    routePattern: /creator
                  - kind: core_search
                    method: POST
                    quantity: 1
                    routePattern: /profile-db
                  - kind: core_search
                    method: POST
                    quantity: 3
                    routePattern: /all
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/PlanFeatureRequired'
components:
  parameters:
    ToolPath:
      name: tool
      in: path
      required: true
      schema:
        type: string
        enum:
          - domain-intelligence
          - ip-intelligence
          - epic-games
          - socialclub
          - xbox
          - playstation
  schemas:
    ToolCostsResponse:
      type: object
      required:
        - defaultPrice
        - routes
      properties:
        defaultPrice:
          oneOf:
            - type: 'null'
            - type: object
              required:
                - kind
                - quantity
              properties:
                kind:
                  type: string
                  enum:
                    - free
                    - core_search
                    - disabled
                quantity:
                  type: integer
              additionalProperties: false
        routes:
          type: array
          items:
            $ref: '#/components/schemas/ToolRouteCost'
      additionalProperties: false
    ToolRouteCost:
      type: object
      required:
        - kind
        - method
        - quantity
        - routePattern
      properties:
        kind:
          type: string
          enum:
            - free
            - core_search
            - disabled
        method:
          type:
            - string
            - 'null'
        quantity:
          type: integer
        routePattern:
          type: string
      additionalProperties: false
    ErrorResponse:
      type: object
      required:
        - error
        - meta
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
          additionalProperties: true
        meta:
          $ref: '#/components/schemas/ResponseMeta'
      additionalProperties: false
      example:
        error:
          code: UNAUTHORIZED
          message: Unauthorized
          details: A valid API key is required
        meta:
          timestamp: '2026-06-28T12:00:00.000Z'
    ResponseMeta:
      type: object
      required:
        - timestamp
      properties:
        timestamp:
          type: string
          format: date-time
        savedResult:
          $ref: '#/components/schemas/SavedToolResult'
      additionalProperties: true
    SavedToolResult:
      type: object
      required:
        - id
        - url
      properties:
        id:
          type: string
          format: uuid
        url:
          type: string
          format: uri
      additionalProperties: false
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: UNAUTHORIZED
              message: Unauthorized
              details: A valid API key is required
            meta:
              timestamp: '2026-06-28T12:00:00.000Z'
    PlanFeatureRequired:
      description: >-
        The authenticated account does not have a paid API subscription with
        tools access
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: PLAN_FEATURE_REQUIRED
              message: Plan feature required
              details: >-
                Tools require a paid API subscription with the tools feature
                enabled
            meta:
              timestamp: '2026-06-28T12:00:00.000Z'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key

````