Store request

POST /api/v1/requests

Api key Bearer

application/json

Body Required

location string Required

Default value is US.
language string Required

Default value is en.
url string Required
plugin string
state string

requester state with unique value to match the response with unique id with will be returned to the callback without any change
responseType string Required

type of response that we need to give

Values are html, plugin, or all. Default value is all.
mode string Required

behavior of crawler

Values are with_js or without_js. Default value is with_js.
callbackUrl string Required

an post url https/http endpoint to submit response when completed
proxy object

proxy details to securely crawl the data if you want to use your own
Hide proxy attributes Show proxy attributes object
- port number Required
- host string Required
- protocol string Required
  
  Values are http, https, socks4, or socks5.
- username string Required
- password string Required

Responses

201 application/json

Request successfully stored.
Hide response attributes Show response attributes object
- is_error boolean Required
- message string Required
- correlator_id string Required
- data object Required
  
  Hide data attributes Show data attributes object
  
  id string Required
  
  location string Required
  
  language string Required
  
  url string Required
  
  plugin string | null Required
  
  state string | null Required
  
  response_type string Required
  
  mode string Required
  
  callback_url string Required
  
  proxy_host string | null Required
  
  proxy_protocol string | null Required
  
  proxy_port number | null Required
  
  proxy_username string | null Required
  
  proxy_password string | null Required
  
  callback_status string | null Required
  
  callback string Required
  
  crawler_data object Required
  
  Hide crawler_data attributes Show crawler_data attributes object
  
  status string Required
  
  error string Required
  
  response string Required
  
  plugin_data object Required
  
  Hide plugin_data attributes Show plugin_data attributes object
  
  status string Required
  
  error string Required
  
  response string Required
  
  created_at string Required
  
  updated_at string Required
  
  status string | null Required
  
  Values are in_progress, failed, or success.
401 application/json

Login required to store an request
Hide response attributes Show response attributes object
- is_error boolean Required
- message string Required
- correlator_id string Required
- data object Required
404 application/json

User not found
Hide response attributes Show response attributes object
- is_error boolean Required
- message string Required
- correlator_id string Required
- data object Required
422 application/json

validation errors
Hide response attributes Show response attributes object
- is_error boolean Required
- message string Required
- correlator_id string Required
- data object Required

POST /api/v1/requests

curl \
 --request POST 'https://api.crawlora.com/api/v1/requests' \
 --header "x-api-key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"location":"US","language":"en","url":"string","plugin":"string","state":"string","responseType":"all","mode":"with_js","callbackUrl":"string","proxy":{"port":42.0,"host":"string","protocol":"http","username":"string","password":"string"}}'

Request examples

{
  "location": "US",
  "language": "en",
  "url": "string",
  "plugin": "string",
  "state": "string",
  "responseType": "all",
  "mode": "with_js",
  "callbackUrl": "string",
  "proxy": {
    "port": 42.0,
    "host": "string",
    "protocol": "http",
    "username": "string",
    "password": "string"
  }
}

Response examples (201)

{
  "is_error": true,
  "message": "string",
  "correlator_id": "string",
  "data": {
    "id": "string",
    "location": "string",
    "language": "string",
    "url": "string",
    "plugin": "string",
    "state": "string",
    "response_type": "string",
    "mode": "string",
    "callback_url": "string",
    "proxy_host": "string",
    "proxy_protocol": "string",
    "proxy_port": 42.0,
    "proxy_username": "string",
    "proxy_password": "string",
    "callback_status": "string",
    "callback": "string",
    "crawler_data": {
      "status": "string",
      "error": "string",
      "response": "string"
    },
    "plugin_data": {
      "status": "string",
      "error": "string",
      "response": "string"
    },
    "created_at": "string",
    "updated_at": "string",
    "status": "in_progress"
  }
}

Response examples (401)

{
  "is_error": true,
  "message": "string",
  "correlator_id": "string",
  "data": {}
}

Response examples (404)

{
  "is_error": true,
  "message": "string",
  "correlator_id": "string",
  "data": {}
}

Response examples (422)

{
  "is_error": true,
  "message": "string",
  "correlator_id": "string",
  "data": {}
}