Inputs V5 (beta)

See which inputs this bot takes.

The v5 version of v4 param_info. It tells you the names to put in inputs for collections, settings and plans, and the values you can choose. Read the currently saved values in Settings.

Endpoints

  • GET /v5/api/bots/{bot_id}/inputs Input field definitions: name, type, options, required and Excel support

Input definitions

Example request 
curl 'https://www.hashscraper.com/v5/api/bots/8f3a7c1e9b5d24f6/inputs' \
  -H 'Authorization: Bearer YOUR_API_KEY'
Example response 200 
{
  "result": "success",
  "version": "v5",
  "request_id": "req_5a8c1f1c-9b2d-4e7c-9abf-3f7e0a4d1b21",
  "elapsed_sec": 0.0123,
  "data": {
    "bot_id": "8f3a7c1e9b5d24f6",
    "excel_supported": true,
    "inputs": [
      {
        "key": "param1",
        "name": "Keyword",
        "name_en": "Keyword",
        "alias": "keyword",
        "type": "text",
        "required": true,
        "options": [],
        "excel_supported": true
      },
      {
        "key": "param2",
        "name": "Sort",
        "name_en": "Sort",
        "alias": "sort",
        "type": "select",
        "required": true,
        "options": [
          {
            "name": "Popular",
            "name_en": "Popular",
            "value": "popular"
          },
          {
            "name": "Newest",
            "name_en": "Newest",
            "value": "newest"
          }
        ],
        "excel_supported": true
      }
    ]
  }
}

Response fields

FieldDescription
excel_supportedBot-level value: whether the bot supports uploading an Excel file (note: collecting with Excel is not available in v5 yet).
inputs[].keyparam1 to param10. Only fields in use are listed.
name, name_enThe field name shown on screen (Korean, English). It is for display and is not a key.
aliasThe English alias set on the bot, or null. You can send this name as the inputs key instead of paramN.
typeselect when there are values to choose from, otherwise text.
requiredtrue for every field in use.
optionsFor select, [{ name, name_en, value }]. Send the value in requests.
excel_supportedWhether this field can be filled from an Excel column.

How to use them in requests

In collection, settings and plan requests, inputs looks like { "param1": "value" } or { "keyword": "value" } (alias). Sending the same field as both paramN and its alias gives INVALID_PARAM, and so do fields the bot does not use and unknown keys (details.unknown_keys). Values are strings or numbers (null is not allowed in a collection request).

Related guides