Upload Excel Parameter V2

POST https://www.hashscraper.com/api/set_excel_param Content-Type: multipart/form-data

Upload an Excel file and register it as the scraper's parameter set.

This endpoint is called with multipart/form-data, not JSON. Attach a .xlsx file to the excel_file field, and it becomes the scraper's active parameter set.

On success, every other parameter set previously registered on the same scraper is deactivated, leaving only the one you just uploaded as active.

A multipart request cannot carry the version in the Content-Type header, so also send version=2 as a form field (without it the request returns 404).

The value in the N-th column becomes paramN (e.g. column 1 → param1, column 5 → param5). Empty columns are skipped. Every row from the first one is collected as one run, so a header row is collected too.

Request Parameters

  • api_key: String
    HashScraper API key
    Example YOUR_API_KEY
  • schedule_id: String
    ID of the scraper to register the parameter set on.
    Example YOUR_SCHEDULE_ID
  • excel_file: File
    .xlsx file. Sent as a multipart/form-data field with MIME type application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.

Response Fields

  • result: String
    Request outcome.
    Allowed success, error
  • version: String
    API version.
    Example v2
  • schedule_id: String
    Identifier of the scraper the parameter set was registered on.
  • file_name: String
    Original filename of the uploaded Excel file.
  • message: String
    Success message. Always returns Excel Parameter saved successfully.
  • elapsed_time: Float
    Server-side processing time (seconds, as a numeric value).
    Example 0.0512

Error Responses

  • schedule_id missing
    Required parameter schedule_id was not provided.
    {
  "result": "error",
  "version": "v2",
  "message": "`schedule_id` parameter is required"
}
  • excel_file missing
    Required parameter excel_file was not provided.
    {
  "result": "error",
  "version": "v2",
  "message": "`excel_file` 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 file extension
    The file extension is not .xlsx or .xls.
    {
  "result": "error",
  "version": "v2",
  "message": "xlsx 또는 xls 형식의 파일을 선택해주세요"
}
  • Invalid content type
    The MIME type of excel_file is not application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.
    {
  "result": "error",
  "version": "v2",
  "message": "\"excel_file\"의 type을 application/vnd.openxmlformats-officedocument.spreadsheetml.sheet로 설정해주세요. ..."
}

Related Guides

Example Request 
curl -X POST \
  -F "api_key=YOUR_API_KEY" \
  -F "version=2" \
  -F "schedule_id=YOUR_SCHEDULE_ID" \
  -F "excel_file=@/path/to/file.xlsx;type=application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" \
  'https://www.hashscraper.com/api/set_excel_param'
Example Response 200 
{
  "result": "success",
  "version": "v2",
  "schedule_id": "사람인_채용공고_수집_1697441449957",
  "file_name": "params.xlsx",
  "message": "Excel Parameter saved successfully",
  "elapsed_time": 0.0512
}