const { HTTPSnippet } = require('httpsnippet') // Each entry: { fence, label, render: ({ method, url, params, body }) => string } // `params` is an array of { name, value } (query params) and `body` is a // parsed JSON-compatible object (request body) — pass `null` for methods // without a body. const extractParams = (properties) => Object.keys(properties) .map((key) => { const property = properties[key] if (property.default === undefined) return null return { name: property.title.split(' ')[0], value: property.default } }) .filter(Boolean) const esc = { dq: (s) => String(s).replace(/\\/g, '\\\\').replace(/"/g, '\\"'), shell: (s) => String(s).replace(/'/g, `'\\''`), } const hasBody = (method) => ['POST', 'PUT', 'PATCH'].includes(method) // ---------------- curl ----------------------------------------------------- const renderCurl = ({ method, url, params, body }) => { if (hasBody(method)) { return [ `curl --request ${method} \\`, ` --url '${url}' \\`, ` --header 'Content-Type: application/json' \\`, ` --header 'x-api-key: ' \\`, ` --data '${JSON.stringify(body)}'`, ].join('\n') } const useG = params.length > 0 const lines = [ `curl --request ${method}${useG ? ' -G' : ''} \\`, ` --url '${url}' \\`, ] for (const { name, value } of params) { lines.push(` --data-urlencode '${esc.shell(name)}=${esc.shell(value)}' \\`) } lines.push(` --header 'Content-Type: application/json' \\`) lines.push(` --header 'x-api-key: '`) return lines.join('\n') } // ---------------- Node.js (axios) / Python (requests) --------------------- const renderNode = (req) => buildSnippet(req).convert('node', 'axios') const renderPython = (req) => buildSnippet(req).convert('python', 'requests') // ---------------- PHP (curl) ----------------------------------------------- const phpValue = (value) => { if (typeof value === 'number' || typeof value === 'boolean') return String(value) if (value === null) return 'null' if (Array.isArray(value)) return '[' + value.map(phpValue).join(', ') + ']' if (typeof value === 'object') { return '[' + Object.entries(value).map(([k, v]) => `"${esc.dq(k)}" => ${phpValue(v)}`).join(', ') + ']' } return `"${esc.dq(value)}"` } const renderPhp = ({ method, url, params, body }) => { const headers = ` CURLOPT_HTTPHEADER => [ "Content-Type: application/json", "x-api-key: ", ],` if (hasBody(method)) { const entries = Object.entries(body) .map(([k, v]) => ` "${esc.dq(k)}" => ${phpValue(v)},`) .join('\n') return ` "${url}", CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => "${method}", CURLOPT_POSTFIELDS => json_encode($payload), ${headers} ]); $response = curl_exec($curl); curl_close($curl); echo $response;` } if (params.length === 0) { return ` "${url}", CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => "${method}", ${headers} ]); $response = curl_exec($curl); curl_close($curl); echo $response;` } const entries = params .map(({ name, value }) => ` "${esc.dq(name)}" => "${esc.dq(value)}",`) .join('\n') return ` "${url}?" . http_build_query($params), CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => "${method}", ${headers} ]); $response = curl_exec($curl); curl_close($curl); echo $response;` } // ---------------- Java (OkHttp) -------------------------------------------- // Pretty-printed JSON embedded as a Java text block. const javaTextBlock = (obj) => { const json = JSON.stringify(obj, null, 2) return '"""\n' + json.split('\n').map((l) => ' ' + l).join('\n') + '\n"""' } const renderJava = ({ method, url, params, body }) => { if (hasBody(method)) { const jsonLiteral = javaTextBlock(body) const verbMethod = method === 'POST' ? '.post(requestBody)' : method === 'PUT' ? '.put(requestBody)' : '.patch(requestBody)' return `OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); String json = ${jsonLiteral}; RequestBody requestBody = RequestBody.create(json, mediaType); Request request = new Request.Builder() .url("${url}") ${verbMethod} .addHeader("Content-Type", "application/json") .addHeader("x-api-key", "") .build(); Response response = client.newCall(request).execute();` } const verbMethod = method === 'GET' ? '.get()' : method === 'DELETE' ? '.delete()' : method === 'HEAD' ? '.head()' : `.method("${method}", null)` if (params.length === 0) { return `OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("${url}") ${verbMethod} .addHeader("Content-Type", "application/json") .addHeader("x-api-key", "") .build(); Response response = client.newCall(request).execute();` } const qs = params .map(({ name, value }) => ` .addQueryParameter("${esc.dq(name)}", "${esc.dq(value)}")`) .join('\n') return `OkHttpClient client = new OkHttpClient(); HttpUrl url = HttpUrl.parse("${url}") .newBuilder() ${qs} .build(); Request request = new Request.Builder() .url(url) ${verbMethod} .addHeader("Content-Type", "application/json") .addHeader("x-api-key", "") .build(); Response response = client.newCall(request).execute();` } // ---------------- C# (HttpClient) ------------------------------------------ // JSON embedded as a C# raw string literal (C# 11+). Surrounded by enough // double-quotes to exceed any run of quotes in the content. const csharpRawString = (obj) => { const json = JSON.stringify(obj, null, 2) const longest = (json.match(/"+/g) || []).reduce((m, s) => Math.max(m, s.length), 0) const delim = '"'.repeat(Math.max(3, longest + 1)) return `${delim}\n${json}\n${delim}` } const renderCsharp = ({ method, url, params, body }) => { if (hasBody(method)) { const rawJson = csharpRawString(body) return `using System.Net.Http; using System.Text; var client = new HttpClient(); var json = ${rawJson}; var content = new StringContent(json, Encoding.UTF8, "application/json"); var request = new HttpRequestMessage(new HttpMethod("${method}"), "${url}") { Content = content, }; request.Headers.Add("x-api-key", ""); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);` } if (params.length === 0) { return `using System.Net.Http; var client = new HttpClient(); var request = new HttpRequestMessage(new HttpMethod("${method}"), "${url}"); request.Headers.Add("x-api-key", ""); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); var content = await response.Content.ReadAsStringAsync(); Console.WriteLine(content);` } const entries = params .map(({ name, value }) => `query["${esc.dq(name)}"] = "${esc.dq(value)}";`) .join('\n') return `using System.Net.Http; using System.Web; var client = new HttpClient(); var query = HttpUtility.ParseQueryString(string.Empty); ${entries} var url = $"${url}?{query}"; var request = new HttpRequestMessage(new HttpMethod("${method}"), url); request.Headers.Add("x-api-key", ""); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); var content = await response.Content.ReadAsStringAsync(); Console.WriteLine(content);` } // ---------------- Ruby (Net::HTTP) ----------------------------------------- const rubyValue = (v) => { if (typeof v === 'number' || typeof v === 'boolean') return String(v) if (v === null) return 'nil' if (Array.isArray(v)) return '[' + v.map(rubyValue).join(', ') + ']' if (typeof v === 'object') { return '{' + Object.entries(v).map(([k, x]) => `"${esc.dq(k)}" => ${rubyValue(x)}`).join(', ') + '}' } return `"${esc.dq(v)}"` } const rubyRequestClass = (method) => { const map = { GET: 'Get', POST: 'Post', PUT: 'Put', PATCH: 'Patch', DELETE: 'Delete', HEAD: 'Head' } return map[method] || 'Get' } const renderRuby = ({ method, url, params, body }) => { const reqClass = rubyRequestClass(method) if (hasBody(method)) { const entries = Object.entries(body) .map(([k, v]) => ` "${esc.dq(k)}" => ${rubyValue(v)},`) .join('\n') return `require 'net/http' require 'uri' require 'json' uri = URI("${url}") payload = { ${entries} } http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = true request = Net::HTTP::${reqClass}.new(uri) request["Content-Type"] = 'application/json' request["x-api-key"] = '' request.body = payload.to_json response = http.request(request) puts response.read_body` } if (params.length === 0) { return `require 'net/http' require 'uri' uri = URI("${url}") http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = true request = Net::HTTP::${reqClass}.new(uri) request["Content-Type"] = 'application/json' request["x-api-key"] = '' response = http.request(request) puts response.read_body` } const entries = params .map(({ name, value }) => ` "${esc.dq(name)}" => "${esc.dq(value)}",`) .join('\n') return `require 'net/http' require 'uri' uri = URI("${url}") params = { ${entries} } uri.query = URI.encode_www_form(params) http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = true request = Net::HTTP::${reqClass}.new(uri) request["Content-Type"] = 'application/json' request["x-api-key"] = '' response = http.request(request) puts response.read_body` } // ---------------- Go ------------------------------------------------------- const goRawJson = (obj) => { const json = JSON.stringify(obj, null, 2) // Escape any literal backticks so Go's raw string literal remains valid. return json.replace(/`/g, '` + "`" + `') } const renderGo = ({ method, url, params, body }) => { if (hasBody(method)) { const payload = goRawJson(body) return `package main import ( \t"bytes" \t"fmt" \t"io" \t"net/http" ) func main() { \tpayload := []byte(\`${payload}\`) \treq, _ := http.NewRequest("${method}", "${url}", bytes.NewBuffer(payload)) \treq.Header.Add("Content-Type", "application/json") \treq.Header.Add("x-api-key", "") \tres, _ := http.DefaultClient.Do(req) \tdefer res.Body.Close() \tresponseBody, _ := io.ReadAll(res.Body) \tfmt.Println(string(responseBody)) }` } if (params.length === 0) { return `package main import ( \t"fmt" \t"io" \t"net/http" ) func main() { \treq, _ := http.NewRequest("${method}", "${url}", nil) \treq.Header.Add("Content-Type", "application/json") \treq.Header.Add("x-api-key", "") \tres, _ := http.DefaultClient.Do(req) \tdefer res.Body.Close() \tbody, _ := io.ReadAll(res.Body) \tfmt.Println(string(body)) }` } const entries = params .map(({ name, value }) => `\tparams.Set("${esc.dq(name)}", "${esc.dq(value)}")`) .join('\n') return `package main import ( \t"fmt" \t"io" \t"net/http" \t"net/url" ) func main() { \tparams := url.Values{} ${entries} \tu := "${url}?" + params.Encode() \treq, _ := http.NewRequest("${method}", u, nil) \treq.Header.Add("Content-Type", "application/json") \treq.Header.Add("x-api-key", "") \tres, _ := http.DefaultClient.Do(req) \tdefer res.Body.Close() \tbody, _ := io.ReadAll(res.Body) \tfmt.Println(string(body)) }` } // ---------------- HasData CLI ---------------------------------------------- // Maps the API endpoint URL to the corresponding `hasdata` CLI subcommand. // CLI doesn't cover scraper jobs (api.hasdata.com/scrapers/...) — those URLs // resolve to null here and the renderer signals "skip" to the caller. const HASDATA_CLI_COMMANDS = { 'https://api.hasdata.com/scrape/web': 'web-scraping', 'https://api.hasdata.com/scrape/google/serp': 'google-serp', 'https://api.hasdata.com/scrape/google-light/serp': 'google-serp-light', 'https://api.hasdata.com/scrape/google/ai-mode': 'google-ai-mode', 'https://api.hasdata.com/scrape/google/news': 'google-news', 'https://api.hasdata.com/scrape/google/shopping': 'google-shopping', 'https://api.hasdata.com/scrape/google/immersive-product': 'google-immersive-product', 'https://api.hasdata.com/scrape/google/events': 'google-events', 'https://api.hasdata.com/scrape/google/short-videos': 'google-short-videos', 'https://api.hasdata.com/scrape/google/images': 'google-images', 'https://api.hasdata.com/scrape/google/flights': 'google-flights', 'https://api.hasdata.com/scrape/google-trends/search': 'google-trends', 'https://api.hasdata.com/scrape/google-maps/search': 'google-maps', 'https://api.hasdata.com/scrape/google-maps/place': 'google-maps-place', 'https://api.hasdata.com/scrape/google-maps/reviews': 'google-maps-reviews', 'https://api.hasdata.com/scrape/google-maps/photos': 'google-maps-photos', 'https://api.hasdata.com/scrape/google-maps/contributor-reviews':'google-maps-contributor-reviews', 'https://api.hasdata.com/scrape/bing/serp': 'bing-serp', 'https://api.hasdata.com/scrape/amazon/product': 'amazon-product', 'https://api.hasdata.com/scrape/amazon/search': 'amazon-search', 'https://api.hasdata.com/scrape/amazon/seller': 'amazon-seller', 'https://api.hasdata.com/scrape/amazon/seller-products': 'amazon-seller-products', 'https://api.hasdata.com/scrape/amazon/reviews': 'amazon-reviews', 'https://api.hasdata.com/scrape/zillow/listing': 'zillow-listing', 'https://api.hasdata.com/scrape/zillow/property': 'zillow-property', 'https://api.hasdata.com/scrape/redfin/listing': 'redfin-listing', 'https://api.hasdata.com/scrape/redfin/property': 'redfin-property', 'https://api.hasdata.com/scrape/airbnb/listing': 'airbnb-listing', 'https://api.hasdata.com/scrape/airbnb/property': 'airbnb-property', 'https://api.hasdata.com/scrape/yelp/search': 'yelp-search', 'https://api.hasdata.com/scrape/yelp/place': 'yelp-place', 'https://api.hasdata.com/scrape/yellowpages/search': 'yellowpages-search', 'https://api.hasdata.com/scrape/yellowpages/place': 'yellowpages-place', 'https://api.hasdata.com/scrape/indeed/listing': 'indeed-listing', 'https://api.hasdata.com/scrape/indeed/job': 'indeed-job', 'https://api.hasdata.com/scrape/glassdoor/listing': 'glassdoor-listing', 'https://api.hasdata.com/scrape/glassdoor/job': 'glassdoor-job', 'https://api.hasdata.com/scrape/instagram/profile': 'instagram-profile', 'https://api.hasdata.com/scrape/shopify/products': 'shopify-products', 'https://api.hasdata.com/scrape/shopify/collections': 'shopify-collections', } const camelToKebab = (s) => s.replace(/([a-z0-9])([A-Z])/g, '$1-$2').toLowerCase() const cliShellQuote = (s) => `'${String(s).replace(/'/g, `'\\''`)}'` const isPrimitive = (v) => v === null || ['string', 'number', 'boolean'].includes(typeof v) const cliRenderScalar = (v) => { if (typeof v === 'number' || typeof v === 'boolean') return String(v) const s = String(v) return /^[A-Za-z0-9_\-.]+$/.test(s) ? s : cliShellQuote(s) } const renderHasdataFlag = (name, value) => { const kebab = camelToKebab(name) const flag = '--' + kebab if (value === null || value === undefined) return null if (typeof value === 'boolean') return value ? flag : `--no-${kebab}` if (Array.isArray(value)) { // Arrays of primitives are comma-separated string slices; arrays of // objects fall back to the `---json` form. if (value.every(isPrimitive)) { return `${flag} ${cliRenderScalar(value.join(','))}` } return `${flag}-json ${cliShellQuote(JSON.stringify(value))}` } if (typeof value === 'object') { return `${flag}-json ${cliShellQuote(JSON.stringify(value))}` } return `${flag} ${cliRenderScalar(value)}` } const renderHasdata = ({ method, url, params, body }) => { // Specs from the upstream api-gateway repo emit api.scrape-it.cloud URLs; // build.sh sed-replaces them post-generation, but we need the canonical // host for the lookup here. const canonicalUrl = url.replace('api.scrape-it.cloud', 'api.hasdata.com') const cmd = HASDATA_CLI_COMMANDS[canonicalUrl] if (!cmd) return null const entries = hasBody(method) ? Object.entries(body || {}).map(([name, value]) => ({ name, value })) : params const flags = entries.map(({ name, value }) => renderHasdataFlag(name, value)).filter(Boolean) if (flags.length === 0) return `hasdata ${cmd}` return [`hasdata ${cmd} \\`, ...flags.map((f, i) => ' ' + f + (i === flags.length - 1 ? '' : ' \\'))].join('\n') } // ---------------- Rust (reqwest) ------------------------------------------- const rustMethod = (method) => { const map = { GET: 'get', POST: 'post', PUT: 'put', PATCH: 'patch', DELETE: 'delete', HEAD: 'head' } return map[method] || method.toLowerCase() } const renderRust = ({ method, url, params, body }) => { const verb = rustMethod(method) if (hasBody(method)) { const bodyJson = JSON.stringify(body, null, 4) .split('\n') .map((line, i) => (i === 0 ? line : ' ' + line)) .join('\n') return `use reqwest::blocking::Client; use serde_json::json; fn main() -> Result<(), Box> { let client = Client::new(); let payload = json!(${bodyJson}); let res = client .${verb}("${url}") .header("Content-Type", "application/json") .header("x-api-key", "") .json(&payload) .send()? .text()?; println!("{}", res); Ok(()) }` } if (params.length === 0) { return `use reqwest::blocking::Client; fn main() -> Result<(), Box> { let client = Client::new(); let res = client .${verb}("${url}") .header("Content-Type", "application/json") .header("x-api-key", "") .send()? .text()?; println!("{}", res); Ok(()) }` } const qs = params .map(({ name, value }) => ` .query(&[("${esc.dq(name)}", "${esc.dq(value)}")])`) .join('\n') return `use reqwest::blocking::Client; fn main() -> Result<(), Box> { let client = Client::new(); let res = client .${verb}("${url}") ${qs} .header("Content-Type", "application/json") .header("x-api-key", "") .send()? .text()?; println!("{}", res); Ok(()) }` } // ---------------- httpsnippet helper for node/python ----------------------- const buildSnippet = ({ method, url, params, body }) => { const opts = {} if (params && params.length > 0) { opts.queryString = params.map(({ name, value }) => ({ name, value: String(value) })) } if (hasBody(method) && body !== null) { opts.postData = { mimeType: 'application/json', text: JSON.stringify(body) } } return new HTTPSnippet({ method, url, headers: [ { name: 'Content-Type', value: 'application/json' }, { name: 'x-api-key', value: '' }, ], ...opts, }) } // ---------------- language registry ---------------------------------------- const languages = { curl: { fence: 'bash', label: 'cURL', render: renderCurl }, hasdata: { fence: 'bash', label: 'HasData CLI', render: renderHasdata }, node: { fence: 'javascript', label: 'Node.js', render: renderNode }, python: { fence: 'python', label: 'Python', render: renderPython }, php: { fence: 'php', label: 'PHP', render: renderPhp }, java: { fence: 'java', label: 'Java', render: renderJava }, csharp: { fence: 'csharp', label: 'C#', render: renderCsharp }, ruby: { fence: 'ruby', label: 'Ruby', render: renderRuby }, rust: { fence: 'rust', label: 'Rust', render: renderRust }, go: { fence: 'go', label: 'Go', render: renderGo }, } // ---------------- entry point ---------------------------------------------- const render = ({ language, api }) => { const cfg = languages[language] if (!cfg) throw new Error(`Unsupported language: ${language}`) const method = (api.method || 'GET').toUpperCase() const params = !hasBody(method) ? extractParams(api.properties) : [] const body = hasBody(method) ? Object.fromEntries(extractParams(api.properties).map(({ name, value }) => [name, value])) : null const code = cfg.render({ method, url: api.url, params, body }) if (code == null) return null return `\`\`\`${cfg.fence} ${cfg.label} ${code.trim()} \`\`\`` } // Low-level renderer used by transform-mdx.js when rewriting hand-written // curl blocks. Caller passes parsed params/body directly. const renderRaw = ({ language, method, url, params = [], body = null }) => { const cfg = languages[language] if (!cfg) throw new Error(`Unsupported language: ${language}`) const code = cfg.render({ method: method.toUpperCase(), url, params, body }) if (code == null) return null return `\`\`\`${cfg.fence} ${cfg.label} ${code.trim()} \`\`\`` } const LANGUAGES = Object.keys(languages) module.exports = render module.exports.renderRaw = renderRaw module.exports.LANGUAGES = LANGUAGES

Get Started

Rich Snippets

Documentation Index