Scraper Parameter Info V4

GET www.hashscraper.com/v4/api/schedules/{schedule_id}/param_info

Returns the input parameter definitions and allowed value lists for a single scraper.

Use this before calling collect to check which parameters are marked as in-use and what values each accepts.

Each param_info entry exposes its allowed value list (options) inline, so clients can discover acceptable values without an extra call.

Request Parameters

  • Authorization: Header
    HashScraper API key. Send it in the form Bearer <api_key>.
    Example Bearer YOUR_API_KEY
  • schedule_id: String (path)
    ID of the scraper to query. Passed as the {schedule_id} path segment. You can copy the Bot ID from Actions → Copy Bot ID on the scraper's detail page.
    Example 8f3a7c1e9b5d24f6

Response Fields

  • result: String
    Result of the request.
    Allowed success, error
  • version: String
    API version.
    Example v4
  • request_id: String
    Request trace ID.
    Example req_5a8c1f1c-...
  • elapsed_sec: Float
    Time the server took to produce the response, in seconds (Float).
    Example 0.0098
  • data: Object
    Scraper metadata and parameter info.
    • id: String
      Echo of the scraper ID.
    • name: String
      Scraper name.
    • param_info: Object
      Scraper input parameters. Keys are stable (param1~paramN) and only in-use slots are included.
      • name: String
        Parameter label (Korean).
      • name_en: String
        Parameter label (English). The key is omitted if not configured.
      • alias: String
        English alias configured for this parameter. You can send it instead of paramN in a request. (omitted if not set)
      • value: String | null
        Current value stored on the scraper. null if unset.
      • options: Array<Object>
        Allowed values for this parameter. The key is omitted for free-form parameters. Each entry has name (Korean), name_en (English), and value (the actual value to send on collect).

Error Responses

  • MISSING_API_KEY
    Missing or malformed Authorization header. Send as Authorization: Bearer <api_key>. (HTTP 401)
    {
  "result": "error",
  "version": "v4",
  "request_id": "req_5a8c1f1c-...",
  "code": "MISSING_API_KEY",
  "message": "API key is missing.",
  "elapsed_sec": 0.0008,
  "details": { "hint": "Send `Authorization: Bearer <api_key>` header." }
}
  • INVALID_API_KEY
    No user matches the provided API key. (HTTP 401)
    {
  "result": "error",
  "version": "v4",
  "request_id": "req_5a8c1f1c-...",
  "code": "INVALID_API_KEY",
  "message": "API key is invalid.",
  "elapsed_sec": 0.0011
}
  • SCHEDULE_NOT_FOUND
    No scraper matches the ID, or the caller does not have access. (HTTP 404)
    {
  "result": "error",
  "version": "v4",
  "request_id": "req_5a8c1f1c-...",
  "code": "SCHEDULE_NOT_FOUND",
  "message": "Schedule not found.",
  "elapsed_sec": 0.0021,
  "details": { "resource": "schedule", "id": "8f3a7c1e9b5d24f6" }
}

Related Guides

Example Request
  • cURL
  • Ruby
  • Python
  • NodeJS
  • PHP
  • Java
Example Response 200 
{
  "result": "success",
  "version": "v4",
  "request_id": "req_5a8c1f1c-9b2d-4e7c-9abf-3f7e0a4d1b21",
  "elapsed_sec": 0.0098,
  "data": {
    "id": "8f3a7c1e9b5d24f6",
    "name": "네이버 뉴스 검색",
    "param_info": {
      "param1": { "name": "키워드", "alias": "keyword", "value": "키성장" },
      "param2": {
        "name": "정렬",
        "alias": "sorting",
        "value": "관련도순",
        "options": [
          { "name": "관련도순", "name_en": "Relevance", "value": "관련도순" },
          { "name": "최신순",   "name_en": "Newest",    "value": "최신순" }
        ]
      }
    }
  }
}