apidirect-io Forums API

openapi: 3.2.0
info:
  title: Apidirect Io Forums API
  version: 1.9.1
  contact:
    name: API Direct support
    url: https://apidirect.io
    email: support@apidirect.io
  termsOfService: https://apidirect.io/terms
  x-refined-note:
  - x-guidance differs across the merged source definitions and was not carried
  x-logo:
    url: https://apidirect.io/static/A.png
    altText: API Direct
  description: 'Operations tagged Forums across 2 of this provider''s published API definitions: apidirect-io-openapi.json, apidirect-io-x402-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://apidirect.io
  description: Production
- description: x402 (pay per request in USDC, no API key)
  url: https://x402.apidirect.io
tags:
- name: Forums
  description: Search forum posts across the web with time and country filters.
paths:
  /v1/forums/posts:
    get:
      tags:
      - Forums
      operationId: searchForums
      summary: Search Forum Posts
      description: 'Search for forum posts across the web, including discussion boards, Q&A sites, and community boards. Each result returns its position and rank, the post title, URL, source forum, domain, and a content snippet. Supports filtering by time period (hour, day, week, month, year) and by country (ISO 3166-1 alpha-2 code). Results are paginated 10 at a time via the page parameter, and count reports how many were returned. The search runs in English. Set get_sentiment=true to add AI emotion analysis to each post.


        **Price:** $0.008 per request. **Free tier:** 50 requests/month.'
      externalDocs:
        url: https://apidirect.io/docs/forum-posts
      parameters:
      - name: query
        in: query
        required: true
        description: Search query (max 500 characters). Leading and trailing whitespace is trimmed, and the query must not be empty.
        schema:
          type: string
          maxLength: 500
        example: programming
      - name: page
        in: query
        required: false
        description: 'Page number for pagination, 1-10 (default: 1). Results are paginated 10 at a time, so page=2 starts at the 11th result. Values below 1, and values that are not numbers, are treated as 1. A page above 10 returns 400.'
        schema:
          type: integer
          minimum: 1
          default: 1
          maximum: 10
      - name: time
        in: query
        required: false
        description: Filter by time period. 'any' applies no time filter. Any value outside this list returns 400.
        schema:
          type: string
          enum:
          - any
          - hour
          - day
          - week
          - month
          - year
          default: any
        example: week
      - name: country
        in: query
        required: false
        description: ISO 3166-1 alpha-2 country code (e.g., US, GB, DE). Case-insensitive. Any value that is not exactly 2 letters returns 400.
        schema:
          type: string
          minLength: 2
          maxLength: 2
        example: US
      - name: get_sentiment
        in: query
        required: false
        description: 'Set to true to add AI emotion analysis to each post. Adds a `sentiment` object containing `emotions` (joy, trust, fear, surprise, sadness, disgust, anger and anticipation, each scored 0-100), `dominant_emotion`, `emotional_intensity` (0-10), and `polarity` (positive, negative or neutral). Any post that cannot be scored returns `sentiment: null`.'
        schema:
          type: boolean
          default: false
      x-example-query:
        query: programming
        time: week
        country: US
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchForumsResponse'
              example:
                count: 10
                page: 1
                posts:
                - domain: reddit.com
                  position: 1
                  rank: 1
                  snippet: Programming is how everything in tech works. It's a set of instructions given to the computer to run a set of tasks. Let's take Google for ...
                  source: Reddit
                  title: 'What is programming? : r/AskProgramming - Reddit'
                  url: https://www.reddit.com/r/AskProgramming/comments/1eo7fez/what_is_programming/
                - domain: sololearn.com
                  position: 2
                  rank: 2
                  snippet: '''%'' this sign stands for modulo sign. It is use to get carry after devision. Like if you are dividing 10 by 3 then carry will be 1 because 3*3 = 9 and 1 will ...'
                  source: Sololearn
                  title: What does "%" mean in programming? - Sololearn
                  url: https://www.sololearn.com/en/Discuss/1629466/what-does-mean-in-programming
                - domain: forum.freecodecamp.org
                  position: 3
                  rank: 3
                  snippet: Computer programming is teaching humans to think like a computer and to write instructions in a human-like meta language that can be translated into the 1s and ...
                  source: The freeCodeCamp Forum
                  title: What is Programming - The freeCodeCamp Forum
                  url: https://forum.freecodecamp.org/t/what-is-programming/484906
                - domain: forums.xfinity.com
                  position: 4
                  rank: 4
                  snippet: E. W. Scripps cable network programming is currently unavailable as our agreement with E. W. Scripps has expired.
                  source: Xfinity Community Forum
                  title: E. W. Scripps Programming Agreement Expired
                  url: https://forums.xfinity.com/conversations/channels-and-programming/e-w-scripps-programming-agreement-expired/69cc2cd7d5983d629c66e1cc
                - domain: itsfoss.community
                  position: 5
                  rank: 5
                  snippet: C is a bit of a strange language. Many things that are hard in C or at least take some thought are taken for granted in newer languages.
                  source: It's FOSS Community
                  title: 'The C Programming Language: Some Initial Thoughts'
                  url: https://itsfoss.community/t/the-c-programming-language-some-initial-thoughts/11881
                - domain: quora.com
                  position: 6
                  rank: 6
                  snippet: Programming is the process of developing software, websites, and other computer applications. It involves writing code in a specific programming ...
                  source: Quora
                  title: What do you understand by computer programming? - Quora
                  url: https://www.quora.com/What-do-you-understand-by-computer-programming
                - domain: careervillage.org
                  position: 7
                  rank: 7
                  snippet: Programming is a process that leads from an original formulation of a computing problem to executable computer programs.
                  source: CareerVillage
                  title: what is programming? | CareerVillage
                  url: https://www.careervillage.org/questions/21116/what-is-programming
                - domain: english.stackexchange.com
                  position: 8
                  rank: 8
                  snippet: The word programming is a Greek word. In Greek the word is "προγραμματισμός" (programmatismos). It refers basically to words united together.
                  source: English Language & Usage Stack Exchange
                  title: '“Programming” versus “programing”: which is preferred?'
                  url: https://english.stackexchange.com/questions/244280/programming-versus-programing-which-is-preferred
                - domain: forums.swift.org
                  position: 9
                  rank: 9
                  snippet: Swift is a general-purpose programming language built using a modern approach to safety, performance, and software design patterns. Also for ...
                  source: Swift Forums
                  title: An Introduction to Programming Using Swift
                  url: https://forums.swift.org/t/an-introduction-to-programming-using-swift/83901
                - domain: windowsforum.com
                  position: 10
                  rank: 10
                  snippet: r/programming has begun a temporary ban on LLM-related posts for a trial period of two to four weeks in April, while still allowing broader AI ...
                  source: Windows Forum
                  title: r/programming Temporarily Bans LLM Posts to Cut AI Hype ...
                  url: https://windowsforum.com/threads/r-programming-temporarily-bans-llm-posts-to-cut-ai-hype-and-restore-technical-signal.409812/
        '400':
          description: 'Bad request: missing query, query over 500 characters, unsupported time value, or a country code that is not 2 letters'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Unauthorized: invalid or missing API key'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: Free tier used up for this endpoint and no payment method on file (`payment_required`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Account blocked after a failed payment (`account_blocked`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded, or too many concurrent requests for this endpoint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Temporary failure retrieving forum data. Please retry shortly.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service temporarily unavailable. Please retry shortly.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '504':
          description: The request timed out
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - ApiKeyAuth: []
    servers:
    - url: https://apidirect.io
      description: Production
components:
  schemas:
    Error:
      type: object
      required:
      - error
      - code
      properties:
        error:
          type: string
          description: Human-readable error message.
        code:
          type: string
          description: Machine-readable error code, such as `missing_parameter`, `invalid_parameter`, `missing_api_key`, `invalid_api_key`, `payment_required`, `account_blocked`, `not_found`, `concurrency_limit_exceeded`, `daily_limit_exceeded`, `monthly_limit_exceeded`, `upstream_rate_limit`, `upstream_error`, `upstream_timeout`, `service_unavailable`, `endpoint_suspended`, `payload_too_large` or `rate_limited`. New codes may be added.
      example:
        error: 'Missing required parameter: query'
        code: missing_parameter
    SearchForumsResponse:
      type: object
      properties:
        count:
          type:
          - number
          - 'null'
        page:
          type:
          - number
          - 'null'
        posts:
          type:
          - array
          - 'null'
          items:
            type:
            - object
            - 'null'
            properties:
              domain:
                type:
                - string
                - 'null'
              position:
                type:
                - number
                - 'null'
              rank:
                type:
                - number
                - 'null'
              snippet:
                type:
                - string
                - 'null'
              source:
                type:
                - string
                - 'null'
              title:
                type:
                - string
                - 'null'
              url:
                type:
                - string
                - 'null'
      description: Inferred from a live response. Any field can be null or absent, and new fields may be added at any time.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your API key (starts with `ak_live_`), from https://apidirect.io/dashboard/keys.
externalDocs:
  description: API Direct documentation
  url: https://apidirect.io/docs
x-refined-from:
- apidirect-io-openapi.json
- apidirect-io-x402-openapi.json