Curl Docs

Avoiding 502 (Bad Gateway) Errors IMPORTANT

Curl sets the Expect:true header by default. You must unset this or you will get 502 Bad Gateway errors with your curl requests. The errors won't occur when your POST payload is small, but medium and large POST payloads will always get this 502 error. See the below examples for how to properly make curl calls. (Pass the -H "Expect:" argument to curl).

Post request body: (request.json)

In the following example Curl request POST body, we submit a request.json file. This file follows either the UserRequest or PageRequest specification, which can be viewed from our HTTP Endpoint docs. The default parameters (for pageRequest parameters you do not explicitly set) can be viewed here.

Minimal Example: Capture a Page as PlainText

This Curl example captures the text from a page and prints to the command-line.

request.json

(in pageRequest format)

{
	"url":"http://example.com",
	"renderType":"plainText"
}

command-line

curl -v -k -H "Content-Type: application/json" -H "Expect:" -X POST -d @request.json "https://PhantomJScloud.com/api/browser/v2/a-demo-key-with-low-quota-per-ip-address/" 

Minimal Example: Verbose output JSON

This Curl example Captures the text from the page and PhantomJsCloud metadata about the request and response, then saves to a .json file.

request.json

(in pageRequest format)

{
	"url":"http://example.com",
	"renderType":"plainText",
	"outputAsJson":true
}

command-line

curl -v -k -H "Content-Type: application/json" -H "Expect:" -X POST -d @request.json "https://PhantomJScloud.com/api/browser/v2/a-demo-key-with-low-quota-per-ip-address/"  -o capture.json

Minimal Example: Capture as JPEG

This Curl example will generate a screenshot of a webpage (including rendering AJAX), then saves to a .jpg file.

request.json

(in pageRequest format)

{
	"url":"http://www.highcharts.com/stock/demo/intraday-area",
	"renderType":"jpeg"
}

command-line

curl -v -k -H "Content-Type: application/json" -H "Expect:" -X POST -d @request.json "https://PhantomJScloud.com/api/browser/v2/a-demo-key-with-low-quota-per-ip-address/"  -o capture.jpg

Minimal Example: Capture as PDF

This Curl example will generate a PDF of Amazon.com's main page (the live, current contents), then saves to a .pdf file.

request.json

(in pageRequest format)

{
	"url":"https://amazon.com",
	"renderType":"pdf"
}

command-line

curl -v -k -H "Content-Type: application/json" -H "Expect:" -X POST -d @request.json "https://PhantomJScloud.com/api/browser/v2/a-demo-key-with-low-quota-per-ip-address/"  -o capture.pdf

Minimal Example: All parameters

This Curl example shows using all PhantomJsCloud parameters in a request, capturing the page as a .jpg image. Most the parameters used are the defaults, but you can see a list of the most up-to-date default values here.

request.json

(in userRequest format)

{
	"pages":[
		{
			"url": "http://example.com",
			"content": null,
			"urlSettings": {
				"operation": "GET",
				"encoding": "utf8",
				"headers": {},
				"data": null
			},
			"renderType": "jpg",
			"outputAsJson": false,
			"requestSettings": {
				"ignoreImages": false,
				"disableJavascript": false,
				"userAgent": "Mozilla/5.0 (Windows NT 6.2; WOW64) AppleWebKit/534.34 (KHTML, like Gecko) Safari/534.34 PhantomJS/2.0.0 (PhantomJsCloud.com/2.0.1)",
				"authentication": {
					"userName": "guest",
					"password": "guest"
				},
				"xssAuditingEnabled": false,
				"webSecurityEnabled": false,
				"resourceWait": 15000,
				"resourceTimeout": 35000,
				"maxWait": 35000,
				"waitInterval": 1000,
				"stopOnError": false,
				"resourceModifier": [],
				"customHeaders": {},
				"clearCache": false,
				"clearCookies": false,
				"cookies": [],
				"deleteCookies": []
			},
			"suppressJson": [
				"events.value.resourceRequest.headers",
				"events.value.resourceResponse.headers",
				"frameData.content",
				"frameData.childFrames"
			],
			"renderSettings": {
				"quality": 70,
				"pdfOptions": {
					"border": null,
					"footer": {
						"firstPage": null,
						"height": "1cm",
						"lastPage": null,
						"onePage": null,
						"repeating": "%pageNum%/%numPages%"
					},
					"format": "letter",
					"header": null,
					"height": null,
					"orientation": "portrait",
					"width": null
				},
				"clipRectangle": null,
				"renderIFrame": null,
				"viewport": {
					"height": 1280,
					"width": 1280
				},
				"zoomFactor": 1,
				"passThroughHeaders": false
			},
			"scripts": {
				"domReady": [],
				"loadFinished": []
			}
		}
	],
	"proxy":false
}

command-line

curl -v -k -H "Content-Type: application/json" -H "Expect:" -X POST -d @request.json "https://PhantomJScloud.com/api/browser/v2/a-demo-key-with-low-quota-per-ip-address/"  -o capture.jpg