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

# Search GitHub topics



## OpenAPI

````yaml /openapi.json post /github/search-topics
openapi: 3.1.0
info:
  title: Bridgly API
  description: >-
    Web scraping API for LinkedIn, X (Twitter) and Reddit. Authenticated
    endpoints accept a Bridgly API key (`bgly_…`) via `Authorization: Bearer
    <token>`.
  version: 1.0.0
servers:
  - url: https://api.bridgly.app
    description: Production
security: []
tags:
  - name: LinkedIn
    description: Scrape LinkedIn profiles, companies, posts, and search.
  - name: Reddit
    description: Scrape Reddit posts, subreddits, users, and search.
  - name: X (Twitter)
    description: Scrape tweets and search X.
  - name: GitHub
    description: >-
      Fetch GitHub profiles, pinned repos, contributions, repositories, stars,
      and projects via GitHub's GraphQL API.
paths:
  /github/search-topics:
    post:
      tags:
        - GitHub
      summary: Search GitHub topics
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                query:
                  description: >-
                    Free-text search terms, matched against the default fields
                    for this search type, e.g. "web framework".
                  type: string
                featured:
                  description: Only featured topics. Maps to `is:featured`.
                  type: boolean
                curated:
                  description: Only curated topics. Maps to `is:curated`.
                  type: boolean
                repositories:
                  description: >-
                    Filter by number of repositories using the topic. Provide
                    any of gt / gte / lt / lte; combine a lower and upper bound
                    for a range.
                  type: object
                  properties:
                    gt:
                      description: Strictly greater than this value.
                      anyOf:
                        - type: number
                        - type: 'null'
                    gte:
                      description: Greater than or equal to this value.
                      anyOf:
                        - type: number
                        - type: 'null'
                    lt:
                      description: Strictly less than this value.
                      anyOf:
                        - type: number
                        - type: 'null'
                    lte:
                      description: Less than or equal to this value.
                      anyOf:
                        - type: number
                        - type: 'null'
                created:
                  description: >-
                    Filter by topic creation date. Provide any of gt / gte / lt
                    / lte as YYYY-MM-DD dates; combine a lower and upper bound
                    for a range.
                  type: object
                  properties:
                    gt:
                      description: Strictly after this date (YYYY-MM-DD).
                      anyOf:
                        - type: string
                          format: date
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
                        - type: 'null'
                    gte:
                      description: On or after this date (YYYY-MM-DD).
                      anyOf:
                        - type: string
                          format: date
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
                        - type: 'null'
                    lt:
                      description: Strictly before this date (YYYY-MM-DD).
                      anyOf:
                        - type: string
                          format: date
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
                        - type: 'null'
                    lte:
                      description: On or before this date (YYYY-MM-DD).
                      anyOf:
                        - type: string
                          format: date
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
                        - type: 'null'
                count:
                  default: 10
                  description: Number of results per page (1–10). Defaults to 10.
                  type: integer
                  minimum: 1
                  maximum: 10
                page:
                  default: 1
                  description: 1-based page number. Defaults to 1.
                  type: integer
                  minimum: 1
                  maximum: 9007199254740991
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  timeMs:
                    type: number
                    description: >-
                      Wall-clock time the request took to complete, in
                      milliseconds.
                  creditsCost:
                    type: number
                    description: Number of account credits this request consumed.
                  data:
                    type: object
                    properties:
                      query:
                        type: string
                        description: The compiled GitHub search query string that was run.
                      totalCount:
                        anyOf:
                          - type: number
                          - type: 'null'
                        description: >-
                          Total matches GitHub reports (approximate, and capped
                          at 1000 results).
                      topics:
                        type: array
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                              description: Topic name (slug), e.g. "machine-learning".
                            displayName:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: Human-friendly display name, or null.
                            shortDescription:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: One-line description.
                            description:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: Longer description, or null.
                            createdBy:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: Who created the topic, or null.
                            featured:
                              type: boolean
                              description: Whether GitHub features this topic.
                            curated:
                              type: boolean
                              description: Whether the topic is curated.
                            score:
                              anyOf:
                                - type: number
                                - type: 'null'
                              description: Search relevance score.
                          required:
                            - name
                            - displayName
                            - shortDescription
                            - description
                            - createdBy
                            - featured
                            - curated
                            - score
                          additionalProperties: false
                        description: Topics matching this page.
                      nextPage:
                        anyOf:
                          - type: number
                          - type: 'null'
                        description: >-
                          The next 1-based page number, or null when this is the
                          last page.
                    required:
                      - query
                      - totalCount
                      - topics
                      - nextPage
                    additionalProperties: false
                required:
                  - timeMs
                  - creditsCost
                  - data
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
        '402':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: typescript
          label: Bridgly SDK
          source: |-
            import { Bridgly } from 'bridgly';

            const client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });

            const res = await client.github.searchTopics({
              count: 10,
              page: 1,
            });
            if (res.type === 'success') console.log(res.data);
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A Bridgly API key (`bgly_…`). Metered endpoints deduct credits from the
        resolved account.

````