Skip to main content
The PHP SDK requires PHP 8.1 or newer and Composer.

Install the SDK

Guzzle provides the HTTP transport. If your project already has a compatible PSR-18 client and PSR-17 factories, you can keep those instead.

Set your API key

Get a secret API key from the dashboard. Set it in the terminal where you will run the example:
Keep the key in server-side code. Do not expose it in a browser or commit it to source control.

Scrape a webpage

Save this as scrape.php beside your vendor directory:
scrape.php
Run it from that directory:

Check the result

The example prints the page content as Markdown. Look for the Example Domain heading; the remaining text and formatting may vary.
Expected heading
If you receive an error, check the key and request details in Troubleshooting. See the Markdown API reference for all parameters and response fields.

Retrieve brand data

PHP SDK 2.14.0 requires fields from multiple lookup types in its Brand helper, so it cannot form a valid domain-only lookup. Use the SDK’s low-level request method until the helper is updated. It keeps SDK authentication, retries, and error handling. Save it separately as brand.php:
brand.php
Run php brand.php. It prints the company name. Keep the request path relative (brand/retrieve, without a leading slash) so the SDK preserves /v1 in the base URL.

Next steps

Scrape a webpage

Choose which page content to include.

Retrieve brand data

Look up profiles with other company identifiers.