> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Dataforseo Serp Bing Organic Html: Inputs, Cost & CLI
> Live SERP HTML provides a raw HTML page of search engine results for the specified keyword, search engine, and location.
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=dataforseo_serp_bing_organic_live_html:{"keyword":"{{keyword}}"}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| ----------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `payload.keyword` | `string` | Yes | | keyword required field you can specify up to 700 characters in the keyword field all %## will be decoded (plus character '+' will be decoded to a space character) if you need to use the "%" character for your keyword , please specify it as "%25"; if you need to use the “+” character for your keyword , please specify it as “%2B”; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article |
| `payload.location_code` | `integer` | No | | search engine location code required field if you don't specify location\_name or location\_coordinate if you use this field, you don't need to specify location\_name or location\_coordinate you can receive the list of available locations of the search engines with their location\_code by making a separate request to the [https://api.dataforseo.com/v3/serp/bing/locations](https://api.dataforseo.com/v3/serp/bing/locations) example: 2840 |
| `payload.language_code` | `string` | No | | search engine language code required field if you don't specify language\_name if you use this field, you don't need to specify language\_name you can receive the list of available languages of the search engine with their language\_code by making a separate request to the [https://api.dataforseo.com/v3/serp/bing/languages](https://api.dataforseo.com/v3/serp/bing/languages) example: en |
| `payload.depth` | `integer` | No | | parsing depth optional field number of results in SERP default value: 10 max value: 200 Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results ; The cost can be calculated on the Pricing page. |
| `payload.device` | `string` | No | | device type optional field return results for a specific device type can take the values: desktop , mobile default value: desktop |
| `payload.location_name` | `string` | No | | full name of search engine location required field if you don't specify location\_code or location\_coordinate if you use this field, you don't need to specify location\_code or location\_coordinate you can receive the list of available locations of the search engine with their location\_name by making a separate request to the [https://api.dataforseo.com/v3/serp/bing/locations](https://api.dataforseo.com/v3/serp/bing/locations) example: London,England,United Kingdom |
| `payload.language_name` | `string` | No | | full name of search engine language required field if you don't specify language\_code if you use this field, you don't need to specify language\_code you can receive the list of available languages of the search engine with their language\_name by making a separate request to the [https://api.dataforseo.com/v3/serp/bing/languages](https://api.dataforseo.com/v3/serp/bing/languages) example: English |
| `payload.os` | `string` | No | | device operating system optional field if you specify desktop in the device field, choose from the following values: windows , macos default value: windows if you specify mobile in the device field, choose from the following values: android , ios default value: android |
| `payload.tag` | `string` | No | | user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response |
| `payload.stop_crawl_on_match` | `array` | No | | array of targets to stop crawling optional field specified as an array of target objects each target object consists of one match\_type field and one match\_value field you can specify up to 10 target objects in this array if specified, the response will contain SERP results up to and including the specified match\_value ; example: "stop\_crawl\_on\_match":\[\{"match\_value":"dataforseo.com","match\_type":"with\_subdomains"}] learn more about this parameter on our Help Center Your account will be billed for every SERP crawled until the conditions you specified in this array are met |
| `payload.match_type` | `string` | No | | target match type required field if stop\_crawl\_on\_match is specified type of match for the match\_value possible values: domain – specific domain or subdomain with\_subdomains – main domain and subdomains wildcard – wildcard pattern |
| `payload.match_value` | `string` | No | | target domain, subdomain, or wildcard value required field if stop\_crawl\_on\_match is specified specify a target domain, subdomain, or wildcard value; Note: domain or subdomain must be specified without a request protocol; example: "match\_value": "dataforseo.com" , "match\_value": "/blog/post-\*" |
| `payload.max_crawl_pages` | `integer` | No | | page crawl limit optional field number of search results pages to crawl default value: 1 max value: 100 Note: the max\_crawl\_pages and depth parameters complement each other; learn more at our help center |
| `payload.search_param` | `string` | No | | additional parameters of the search query optional field get the list of available parameters and additional details here |
| `payload.url` | `string` | No | | direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: [https://www.bing.com/search?q=rank%20checker\&count=50\&first=1\&setlang=en\&cc=US\&safesearch=Moderate\&FORM=SEPAGE](https://www.bing.com/search?q=rank%20checker\&count=50\&first=1\&setlang=en\&cc=US\&safesearch=Moderate\&FORM=SEPAGE) |
| `payload.location_coordinate` | `string` | No | | GPS coordinates of a location required field if you don't specify location\_name or location\_code if you use this field, you don't need to specify location\_name or location\_code location\_coordinate parameter should be specified in the "latitude,longitude" format the maximum number of decimal digits for "latitude" and "longitude" : 7 example: 53.476225,-2.243572 |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Live SERP HTML provides a raw HTML page of search engine results for the specified keyword, search engine, and location.",
"properties": {
"keyword": {
"type": "string",
"description": "keyword required field you can specify up to 700 characters in the keyword field all %## will be decoded (plus character '+' will be decoded to a space character) if you need to use the \"%\" character for your keyword , please specify it as \"%25\"; if you need to use the “+” character for your keyword , please specify it as “%2B”; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article"
},
"location_code": {
"type": "integer",
"description": "search engine location code required field if you don't specify location_name or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/bing/locations example: 2840"
},
"language_code": {
"type": "string",
"description": "search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/bing/languages example: en"
},
"depth": {
"type": "integer",
"description": "parsing depth optional field number of results in SERP default value: 10 max value: 200 Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results ; The cost can be calculated on the Pricing page."
},
"device": {
"type": "string",
"description": "device type optional field return results for a specific device type can take the values: desktop , mobile default value: desktop"
},
"location_name": {
"type": "string",
"description": "full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/bing/locations example: London,England,United Kingdom"
},
"language_name": {
"type": "string",
"description": "full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/bing/languages example: English"
},
"os": {
"type": "string",
"description": "device operating system optional field if you specify desktop in the device field, choose from the following values: windows , macos default value: windows if you specify mobile in the device field, choose from the following values: android , ios default value: android"
},
"tag": {
"type": "string",
"description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response"
},
"stop_crawl_on_match": {
"type": "array",
"description": "array of targets to stop crawling optional field specified as an array of target objects each target object consists of one match_type field and one match_value field you can specify up to 10 target objects in this array if specified, the response will contain SERP results up to and including the specified match_value ; example: \"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}] learn more about this parameter on our Help Center Your account will be billed for every SERP crawled until the conditions you specified in this array are met",
"items": {}
},
"match_type": {
"type": "string",
"description": "target match type required field if stop_crawl_on_match is specified type of match for the match_value possible values: domain – specific domain or subdomain with_subdomains – main domain and subdomains wildcard – wildcard pattern"
},
"match_value": {
"type": "string",
"description": "target domain, subdomain, or wildcard value required field if stop_crawl_on_match is specified specify a target domain, subdomain, or wildcard value; Note: domain or subdomain must be specified without a request protocol; example: \"match_value\": \"dataforseo.com\" , \"match_value\": \"/blog/post-*\""
},
"max_crawl_pages": {
"type": "integer",
"description": "page crawl limit optional field number of search results pages to crawl default value: 1 max value: 100 Note: the max_crawl_pages and depth parameters complement each other; learn more at our help center"
},
"search_param": {
"type": "string",
"description": "additional parameters of the search query optional field get the list of available parameters and additional details here"
},
"url": {
"type": "string",
"description": "direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: https://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE"
},
"location_coordinate": {
"type": "string",
"description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude\" format the maximum number of decimal digits for \"latitude\" and \"longitude\" : 7 example: 53.476225,-2.243572"
}
},
"required": [
"keyword"
],
"additionalProperties": false
}
```
## Output Schema
| Name | Type | Required | Default | Description |
| ----------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `result.version` | `string` | Yes | | the current version of the API |
| `result.status_code` | `integer` | Yes | | general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions |
| `result.status_message` | `string` | Yes | | general informational message you can find the full list of general informational messages here |
| `result.time` | `string` | Yes | | execution time, seconds |
| `result.tasks_count` | `integer` | Yes | | the number of tasks in the tasks array |
| `result.tasks_error` | `integer` | Yes | | the number of tasks in the tasks array returned with an error |
| `result.tasks` | `array` | Yes | | array of tasks |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Top-level response envelope for dataforseo_serp_bing_organic_live_html.",
"properties": {
"version": {
"type": "string",
"description": "the current version of the API"
},
"status_code": {
"type": "integer",
"description": "general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions"
},
"status_message": {
"type": "string",
"description": "general informational message you can find the full list of general informational messages here"
},
"time": {
"type": "string",
"description": "execution time, seconds"
},
"tasks_count": {
"type": "integer",
"description": "the number of tasks in the tasks array"
},
"tasks_error": {
"type": "integer",
"description": "the number of tasks in the tasks array returned with an error"
},
"tasks": {
"type": "array",
"description": "array of tasks",
"items": {}
}
},
"required": [
"version",
"status_code",
"status_message",
"time",
"tasks_count",
"tasks_error",
"tasks"
],
"additionalProperties": false
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute dataforseo_serp_bing_organic_live_html --payload '{
"keyword": "string"
}' --json
```
### CLI flags
| Flag | Description |
| --------------------------- | --------------------------------------------------- |
| `--json` | Print machine-readable output. |
| `--wait` | Wait for terminal provider status when supported. |
| `--debug` | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS` | Max seconds to wait in wait mode. |
| `--poll-interval SECONDS` | Polling interval in seconds during wait mode. |
| `--timeout SECONDS` | Request timeout in seconds. |
| `--connect-timeout SECONDS` | Connection timeout in seconds. |
## Cost
* Pricing model: `provider_usage` (provider usage).
* Estimated Deepline credits: `0.03` per pricing unit.
* Billing mode: `post_deduct`.