--- title: Scrape elements. --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Browser Rendering](https://developers.cloudflare.com/api/go/resources/browser_rendering) [Scrape](https://developers.cloudflare.com/api/go/resources/browser_rendering/subresources/scrape) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Scrape elements. client.BrowserRendering.Scrape.New(ctx, params) (\*\[] [ScrapeNewResponse](), error) POST/accounts/{account\_id}/browser-rendering/scrape Get meta attributes like height, width, text and others of selected elements. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Browser Rendering Write` ##### ParametersExpand Collapse
params ScrapeNewParams AccountID param.Field\[string] Path param: Account ID. Link to this property URL param.Field\[string] Body param Link to this property
Browser param.Field\[ScrapeNewParamsVariant0Browser]Optional Query param: Rendering backend. Set to kitesurf to use Kitesurf (beta). const ScrapeNewParamsVariant0BrowserKitesurf ScrapeNewParamsVariant0Browser = "kitesurf" Link to this property
Link to this property CacheTTL param.Field\[float64]Optional Query param: Cache TTL default is 5s. Set to 0 to disable. maximum86400 minimum0 Link to this property ActionTimeout param.Field\[float64]Optional Body param: The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error. maximum120000 Link to this property
AddScriptTag param.Field\[\[]ScrapeNewParamsVariant0AddScriptTag]Optional Body param: Adds a script element into the page with the desired URL or content. ID stringOptional Link to this property Content stringOptional Link to this property Type stringOptional Link to this property URL stringOptional formaturi Link to this property
Link to this property
AddStyleTag param.Field\[\[]ScrapeNewParamsVariant0AddStyleTag]Optional Body param: Adds a <link rel="stylesheet"> tag into the page with the desired URL or a <style type="text/css"> tag with the content. Content stringOptional Link to this property URL stringOptional formaturi Link to this property
Link to this property AllowRequestPattern param.Field\[\[]string]Optional Body param: Only allow requests that match the provided regex patterns, eg. ’/^.\*.(css)’. Reject rules are applied first. Link to this property
AllowResourceTypes param.Field\[\[]ScrapeNewParamsVariant0AllowResourceType]Optional Body param: Only allow requests that match the provided resource types, eg. ‘image’ or ‘script’. Reject rules are applied first. const ScrapeNewParamsVariant0AllowResourceTypeDocument ScrapeNewParamsVariant0AllowResourceType = "document" Link to this property const ScrapeNewParamsVariant0AllowResourceTypeStylesheet ScrapeNewParamsVariant0AllowResourceType = "stylesheet" Link to this property const ScrapeNewParamsVariant0AllowResourceTypeImage ScrapeNewParamsVariant0AllowResourceType = "image" Link to this property const ScrapeNewParamsVariant0AllowResourceTypeMedia ScrapeNewParamsVariant0AllowResourceType = "media" Link to this property const ScrapeNewParamsVariant0AllowResourceTypeFont ScrapeNewParamsVariant0AllowResourceType = "font" Link to this property const ScrapeNewParamsVariant0AllowResourceTypeScript ScrapeNewParamsVariant0AllowResourceType = "script" Link to this property const ScrapeNewParamsVariant0AllowResourceTypeTexttrack ScrapeNewParamsVariant0AllowResourceType = "texttrack" Link to this property const ScrapeNewParamsVariant0AllowResourceTypeXHR ScrapeNewParamsVariant0AllowResourceType = "xhr" Link to this property const ScrapeNewParamsVariant0AllowResourceTypeFetch ScrapeNewParamsVariant0AllowResourceType = "fetch" Link to this property const ScrapeNewParamsVariant0AllowResourceTypePrefetch ScrapeNewParamsVariant0AllowResourceType = "prefetch" Link to this property const ScrapeNewParamsVariant0AllowResourceTypeEventsource ScrapeNewParamsVariant0AllowResourceType = "eventsource" Link to this property const ScrapeNewParamsVariant0AllowResourceTypeWebsocket ScrapeNewParamsVariant0AllowResourceType = "websocket" Link to this property const ScrapeNewParamsVariant0AllowResourceTypeManifest ScrapeNewParamsVariant0AllowResourceType = "manifest" Link to this property const ScrapeNewParamsVariant0AllowResourceTypeSignedexchange ScrapeNewParamsVariant0AllowResourceType = "signedexchange" Link to this property const ScrapeNewParamsVariant0AllowResourceTypePing ScrapeNewParamsVariant0AllowResourceType = "ping" Link to this property const ScrapeNewParamsVariant0AllowResourceTypeCspviolationreport ScrapeNewParamsVariant0AllowResourceType = "cspviolationreport" Link to this property const ScrapeNewParamsVariant0AllowResourceTypePreflight ScrapeNewParamsVariant0AllowResourceType = "preflight" Link to this property const ScrapeNewParamsVariant0AllowResourceTypeOther ScrapeNewParamsVariant0AllowResourceType = "other" Link to this property
Link to this property
Authenticate param.Field\[ScrapeNewParamsVariant0Authenticate]Optional Body param: Provide credentials for HTTP authentication. Password string minLength1 Link to this property Username string minLength1 Link to this property
Link to this property BestAttempt param.Field\[bool]Optional Body param: Attempt to proceed when ‘awaited’ events fail or timeout. Link to this property
Cookies param.Field\[\[]ScrapeNewParamsVariant0Cookie]Optional Body param: Check options. Name string Cookie name. Link to this property Value string Link to this property Domain stringOptional Link to this property Expires float64Optional Link to this property HTTPOnly boolOptional Link to this property PartitionKey stringOptional Link to this property Path stringOptional Link to this property
Priority ScrapeNewParamsVariant0CookiesPriorityOptional One of the following: const ScrapeNewParamsVariant0CookiesPriorityLow ScrapeNewParamsVariant0CookiesPriority = "Low" Link to this property const ScrapeNewParamsVariant0CookiesPriorityMedium ScrapeNewParamsVariant0CookiesPriority = "Medium" Link to this property const ScrapeNewParamsVariant0CookiesPriorityHigh ScrapeNewParamsVariant0CookiesPriority = "High" Link to this property
Link to this property SameParty boolOptional Link to this property
SameSite ScrapeNewParamsVariant0CookiesSameSiteOptional One of the following: const ScrapeNewParamsVariant0CookiesSameSiteStrict ScrapeNewParamsVariant0CookiesSameSite = "Strict" Link to this property const ScrapeNewParamsVariant0CookiesSameSiteLax ScrapeNewParamsVariant0CookiesSameSite = "Lax" Link to this property const ScrapeNewParamsVariant0CookiesSameSiteNone ScrapeNewParamsVariant0CookiesSameSite = "None" Link to this property
Link to this property Secure boolOptional Link to this property SourcePort float64Optional Link to this property
SourceScheme ScrapeNewParamsVariant0CookiesSourceSchemeOptional One of the following: const ScrapeNewParamsVariant0CookiesSourceSchemeUnset ScrapeNewParamsVariant0CookiesSourceScheme = "Unset" Link to this property const ScrapeNewParamsVariant0CookiesSourceSchemeNonSecure ScrapeNewParamsVariant0CookiesSourceScheme = "NonSecure" Link to this property const ScrapeNewParamsVariant0CookiesSourceSchemeSecure ScrapeNewParamsVariant0CookiesSourceScheme = "Secure" Link to this property
Link to this property URL stringOptional Link to this property
Link to this property
Elements param.Field\[\[]ScrapeNewParamsVariant0Element]Optional Body param Selector string Link to this property
Link to this property EmulateMediaType param.Field\[string]Optional Body param Link to this property
GotoOptions param.Field\[ScrapeNewParamsVariant0GotoOptions]Optional Body param: Check options. Referer stringOptional Link to this property ReferrerPolicy stringOptional Link to this property Timeout float64Optional maximum60000 Link to this property
WaitUntil ScrapeNewParamsVariant0GotoOptionsWaitUntilUnionOptional One of the following:
ScrapeNewParamsVariant0GotoOptionsWaitUntilString One of the following: const ScrapeNewParamsVariant0GotoOptionsWaitUntilStringLoad ScrapeNewParamsVariant0GotoOptionsWaitUntilString = "load" Link to this property const ScrapeNewParamsVariant0GotoOptionsWaitUntilStringDomcontentloaded ScrapeNewParamsVariant0GotoOptionsWaitUntilString = "domcontentloaded" Link to this property const ScrapeNewParamsVariant0GotoOptionsWaitUntilStringNetworkidle0 ScrapeNewParamsVariant0GotoOptionsWaitUntilString = "networkidle0" Link to this property const ScrapeNewParamsVariant0GotoOptionsWaitUntilStringNetworkidle2 ScrapeNewParamsVariant0GotoOptionsWaitUntilString = "networkidle2" Link to this property
Link to this property
ScrapeNewParamsVariant0GotoOptionsWaitUntilArray One of the following: const ScrapeNewParamsVariant0GotoOptionsWaitUntilArrayLoad ScrapeNewParamsVariant0GotoOptionsWaitUntilArray = "load" Link to this property const ScrapeNewParamsVariant0GotoOptionsWaitUntilArrayDomcontentloaded ScrapeNewParamsVariant0GotoOptionsWaitUntilArray = "domcontentloaded" Link to this property const ScrapeNewParamsVariant0GotoOptionsWaitUntilArrayNetworkidle0 ScrapeNewParamsVariant0GotoOptionsWaitUntilArray = "networkidle0" Link to this property const ScrapeNewParamsVariant0GotoOptionsWaitUntilArrayNetworkidle2 ScrapeNewParamsVariant0GotoOptionsWaitUntilArray = "networkidle2" Link to this property
Link to this property
Link to this property
Link to this property HTML param.Field\[string]Optional Body param Link to this property RejectRequestPattern param.Field\[\[]string]Optional Body param: Block undesired requests that match the provided regex patterns, eg. ’/^.\*.(css)’. Link to this property
RejectResourceTypes param.Field\[\[]ScrapeNewParamsVariant0RejectResourceType]Optional Body param: Block undesired requests that match the provided resource types, eg. ‘image’ or ‘script’. const ScrapeNewParamsVariant0RejectResourceTypeDocument ScrapeNewParamsVariant0RejectResourceType = "document" Link to this property const ScrapeNewParamsVariant0RejectResourceTypeStylesheet ScrapeNewParamsVariant0RejectResourceType = "stylesheet" Link to this property const ScrapeNewParamsVariant0RejectResourceTypeImage ScrapeNewParamsVariant0RejectResourceType = "image" Link to this property const ScrapeNewParamsVariant0RejectResourceTypeMedia ScrapeNewParamsVariant0RejectResourceType = "media" Link to this property const ScrapeNewParamsVariant0RejectResourceTypeFont ScrapeNewParamsVariant0RejectResourceType = "font" Link to this property const ScrapeNewParamsVariant0RejectResourceTypeScript ScrapeNewParamsVariant0RejectResourceType = "script" Link to this property const ScrapeNewParamsVariant0RejectResourceTypeTexttrack ScrapeNewParamsVariant0RejectResourceType = "texttrack" Link to this property const ScrapeNewParamsVariant0RejectResourceTypeXHR ScrapeNewParamsVariant0RejectResourceType = "xhr" Link to this property const ScrapeNewParamsVariant0RejectResourceTypeFetch ScrapeNewParamsVariant0RejectResourceType = "fetch" Link to this property const ScrapeNewParamsVariant0RejectResourceTypePrefetch ScrapeNewParamsVariant0RejectResourceType = "prefetch" Link to this property const ScrapeNewParamsVariant0RejectResourceTypeEventsource ScrapeNewParamsVariant0RejectResourceType = "eventsource" Link to this property const ScrapeNewParamsVariant0RejectResourceTypeWebsocket ScrapeNewParamsVariant0RejectResourceType = "websocket" Link to this property const ScrapeNewParamsVariant0RejectResourceTypeManifest ScrapeNewParamsVariant0RejectResourceType = "manifest" Link to this property const ScrapeNewParamsVariant0RejectResourceTypeSignedexchange ScrapeNewParamsVariant0RejectResourceType = "signedexchange" Link to this property const ScrapeNewParamsVariant0RejectResourceTypePing ScrapeNewParamsVariant0RejectResourceType = "ping" Link to this property const ScrapeNewParamsVariant0RejectResourceTypeCspviolationreport ScrapeNewParamsVariant0RejectResourceType = "cspviolationreport" Link to this property const ScrapeNewParamsVariant0RejectResourceTypePreflight ScrapeNewParamsVariant0RejectResourceType = "preflight" Link to this property const ScrapeNewParamsVariant0RejectResourceTypeOther ScrapeNewParamsVariant0RejectResourceType = "other" Link to this property
Link to this property SetExtraHTTPHeaders param.Field\[map\[string, string]]Optional Body param Link to this property SetJavaScriptEnabled param.Field\[bool]Optional Body param Link to this property UserAgent param.Field\[string]Optional Body param Link to this property
Viewport param.Field\[ScrapeNewParamsVariant0Viewport]Optional Body param: Check options. Height float64 Link to this property Width float64 Link to this property DeviceScaleFactor float64Optional Link to this property HasTouch boolOptional Link to this property IsLandscape boolOptional Link to this property IsMobile boolOptional Link to this property
Link to this property
WaitForSelector param.Field\[ScrapeNewParamsVariant0WaitForSelector]Optional Body param: Wait for the selector to appear in page. Check options. Selector string Link to this property Hidden ScrapeNewParamsVariant0WaitForSelectorHiddenOptional Link to this property Timeout float64Optional maximum120000 Link to this property Visible ScrapeNewParamsVariant0WaitForSelectorVisibleOptional Link to this property
Link to this property WaitForTimeout param.Field\[float64]Optional Body param: Waits for a specified timeout before continuing. maximum120000 Link to this property
[Link to this property](<#(resource)%20browser_rendering.scrape%20%3E%20(method)%20create%20%3E%20(params)%200>) ##### ReturnsExpand Collapse
type ScrapeNewResponseEnvelopeResult \[]ScrapeNewResponse
Results ScrapeNewResponseResults
Attributes \[]ScrapeNewResponseResultsAttribute Name string Attribute name. Link to this property Value string Attribute value. Link to this property
Link to this property Height float64 Element height. Link to this property HTML string HTML content. Link to this property Left float64 Element left. Link to this property Text string Text content. Link to this property Top float64 Element top. Link to this property Width float64 Element width. Link to this property
Link to this property Selector string Selector. Link to this property
[Link to this property](<#(resource)%20browser_rendering.scrape%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20result>) ### Scrape elements. Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/browser_rendering" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) scrapes, err := client.BrowserRendering.Scrape.New(context.TODO(), browser_rendering.ScrapeNewParams{ AccountID: cloudflare.F("account_id"), Body: browser_rendering.ScrapeNewParamsBodyObject{ URL: cloudflare.F("https://www.example.com/"), }, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", scrapes) } ``` 200 example 429 example ``` { "meta": { "finalUrl": "finalUrl", "headers": { "foo": "string" }, "redirectChain": [ { "headers": { "foo": "string" }, "status": 0, "url": "url" } ], "status": 0, "title": "title" }, "result": [ { "results": { "attributes": [ { "name": "name", "value": "value" } ], "height": 0, "html": "html", "left": 0, "text": "text", "top": 0, "width": 0 }, "selector": "selector" } ], "success": true, "errors": [ { "code": 0, "message": "message" } ] } ``` ``` { "errors": [ { "code": 2001, "message": "Rate limit exceeded" } ], "success": false } ``` ##### Returns Examples 200 example 429 example ``` { "meta": { "finalUrl": "finalUrl", "headers": { "foo": "string" }, "redirectChain": [ { "headers": { "foo": "string" }, "status": 0, "url": "url" } ], "status": 0, "title": "title" }, "result": [ { "results": { "attributes": [ { "name": "name", "value": "value" } ], "height": 0, "html": "html", "left": 0, "text": "text", "top": 0, "width": 0 }, "selector": "selector" } ], "success": true, "errors": [ { "code": 0, "message": "message" } ] } ``` ``` { "errors": [ { "code": 2001, "message": "Rate limit exceeded" } ], "success": false } ```