Update Scraper Settings V2

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

Update a scraper's parameters, execution period, and union option.

The applied configuration is returned as settings in the response.

Any of param1~param5, period, or union that is omitted from the request keeps its current value. Use this to update only a subset of fields.

Requests are rejected when the service ticket has expired or available credits are exhausted. In that case the response uses error_message instead of message.

Request Parameters

  • api_key: String
    HashScraper API key
    Example YOUR_API_KEY
  • schedule_id: String
    ID of the scraper to update.
    Example YOUR_SCHEDULE_ID
  • param1: optional String
    Value to store as param1. Omit to keep the current value.
  • param2: optional String
    Value to store as param2. Same rules apply.
  • param3: optional String
    Value to store as param3. Same rules apply.
  • param4: optional String
    Value to store as param4. Same rules apply.
  • param5: optional String
    Value to store as param5. Same rules apply.
  • period: optional String
    Collection period. One of manual, hour, day. Omit to keep the current value.
    Allowed manual, hour, day
  • union: optional Boolean
    Union option. Must be sent as a JSON Boolean (true/false); strings are rejected.

Response Fields

  • result: String
    Request outcome.
    Allowed success, error
  • version: String
    API version.
    Example v2
  • settings: Object
    Configuration after the update.
    • param1: String | null
      param1 after the update.
    • param2: String | null
      param2 after the update.
    • param3: String | null
      param3 after the update.
    • param4: String | null
      param4 after the update.
    • param5: String | null
      param5 after the update.
    • period: String
      Collection period after the update.
    • union: Boolean
      Union option after the update.
  • elapsed_time: Float
    Server-side processing time (seconds, as a numeric value).
    Example 0.0145

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"
}
  • Invalid union
    union must be a Boolean (true or false).
    {
  "result": "error",
  "version": "v2",
  "message": "union이 Boolean이 아닙니다. union: ..."
}
  • Invalid period
    period must be one of manual, hour, or day.
    {
  "result": "error",
  "version": "v2",
  "message": "period는 'manual, hour, day' 중에서 입력해 주세요. period: ..."
}
  • Service ticket expired
    The service ticket has expired, so the request was rejected. The response uses the error_message key.
    {
  "result": "error",
  "version": "v2",
  "error_message": "서비스 이용권의 기간이 만료되었습니다."
}
  • Credit exhausted
    Available credits are exhausted, so the request was rejected. The response uses the error_message key.
    {
  "result": "error",
  "version": "v2",
  "error_message": "보유하신 크레딧을 모두 사용하셨습니다."
}

Related Guides

Example Request
  • cURL
  • Ruby
  • Python
  • NodeJS
  • PHP
  • Java
Optional parameters
Example Response 200 
{
  "result": "success",
  "version": "v2",
  "settings": {
    "param1": "검색어",
    "param2": null,
    "param3": null,
    "param4": null,
    "param5": null,
    "period": "manual",
    "union": false
  },
  "elapsed_time": 0.0145
}