Scraper · Ações GPT

{
  "openapi": "3.1.0",
  "info": {
    "title": "HQData API",
    "description": "Web scraping API and prebuilt modules by HQData.com",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.hqdata.com"
    }
  ],
  "paths": {
    "/modules/": {
      "get": {
        "summary": "List all available modules and corresponding fields for /run/ endpoint",
        "operationId": "getModules",
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "example": {}
              }
            }
          }
        }
      }
    },
    "/list/": {
      "get": {
        "summary": "Fetches ran jobs and allows filtering by page, status, or specific id",
        "operationId": "getJobList",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Filter jobs by specific id",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "Filter jobs by status (success, failed, pending, running)",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Filter jobs by page",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fetch",
            "in": "query",
            "description": "Request specific result (html, patterns, screenshot)",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "chunks",
            "in": "query",
            "description": "Splits patterns or html into the amount of chunks requested",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "chunk",
            "in": "query",
            "description": "Accesses the requested chunk by integer",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "example": {}
              }
            }
          }
        }
      }
    },
    "/run/": {
      "post": {
        "summary": "Run prebuilt modules listed in the /modules/ endpoint",
        "operationId": "runModules",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "module": {
                    "type": "string"
                  },
                  "url": {
                    "type": "string"
                  },
                  "contact_details": {
                    "type": "string"
                  },
                  "recursive_contact_details": {
                    "type": "string"
                  },
                  "pattern_scan": {
                    "type": "string"
                  },
                  "js_scenario": {
                    "type": "string"
                  },
                  "target": {
                    "type": "string"
                  },
                  "page": {
                    "type": "string"
                  },
                  "query": {
                    "type": "string"
                  },
                  "location": {
                    "type": "string"
                  },
                  "sortbydate": {
                    "type": "string"
                  },
                  "fromage": {
                    "type": "string"
                  }
                },
                "required": [
                  "module"
                ],
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "example": {}
              }
            }
          }
        }
      }
    }
  }
}