Get Scraper Parameter Info V2

POST https://www.hashscraper.com/api/get_param_info Content-Type: application/json; version=2

Inspect the meaning of a scraper's parameters (param1~param10).

Use this endpoint before calling collect or set_schedule to find out which parameters the scraper uses and what each parameter represents.

The shape of param_info here differs from other guides. Keys are the parameter names in use (param1~param10), and values are the corresponding label strings.

Request Parameters

  • api_key: String
    HashScraper API key
    Example YOUR_API_KEY
  • schedule_id: String
    ID of the scraper to inspect.
    Example YOUR_SCHEDULE_ID

Response Fields

  • result: String
    Request outcome.
    Allowed success, error
  • version: String
    API version.
    Example v2
  • name: String
    Scraper name.
  • schedule_id: String
    Scraper identifier.
  • param_info: Object
    Map of the scraper's enabled parameters to their labels. Only param1~param10 that are enabled are included as keys, and each value is that parameter's label (e.g. keyword). Entries without a configured label return null.
  • elapsed_time: Float
    Server-side processing time (seconds, as a numeric value).
    Example 0.0123

Error Responses

  • schedule_id missing
    Required parameter schedule_id was not provided.
    {
  "result": "error",
  "version": "v2",
  "message": "`schedule_id` parameter is required"
}
  • Schedule not found
    No scraper matches the provided schedule_id, or it is not accessible.
    {
  "result": "error",
  "version": "v2",
  "message": "schedule(id: YOUR_SCHEDULE_ID) not found"
}

Related Guides

Example Request
  • cURL
  • Ruby
  • Python
  • NodeJS
  • PHP
  • Java
Example Response 200 
{
  "result": "success",
  "version": "v2",
  "name": "사람인 채용공고 수집",
  "schedule_id": "사람인_채용공고_수집_1697441449957",
  "param_info": {
    "param1": "검색할 키워드",
    "param2": "최대 수집 개수"
  },
  "elapsed_time": 0.0123
}