Skip to main content
POST
Estimate Company Export

Credits and plans

PAYG is Pay-as-you-go. AYCE is All-you-can-eat.

When to use Company Estimate

Check a proposed company file before reserving credits. Send the same filter, columns, format, compression, and maxRows you intend to use for Company Export.

Example

Set REVENUEBASE_API_KEY to your API key.
Response captured from the local test API on October 13, 2026. Results can change as the dataset or account changes.

Read the forecast

creditsEstimate is the amount the service would reserve for this PAYG request. It is null when export metering does not apply, including AYCE. The call creates no export job and reserves no credits. The PAYG chart is 1 credit per company row, plus 10 per SmartSearch filter node per request. Selected company fields do not add contact email/mobile reveal charges.

Estimate, hold, and charge

Estimate and Start use the same calculation. They count matching companies up to maxRows at one credit per company and add 10 credits per SmartSearch node. If 60 companies match and maxRows is 100, the reserve is 60 credits before any SmartSearch fees. A fresh calculation may change if the underlying data or request changes. The final charge uses the companies written plus any SmartSearch node fees. Set a positive integer for maxRows to cap the job. Omit it or send null to use the service maximum of 1,000,000 rows. Sending 0 returns 422 INVALID_REQUEST. Company and person/job criteria are supported for company files.

Errors and retries

Correct unsupported fields or filters before retrying a 400 or 422 response. If a 429 response is returned, wait for Retry-After. Contact and company routes share the default 10 requests per second per user.

Next steps

Review the budget, then call Start Company Export with the same body. Reduce maxRows if the hold is too large.

Authorizations

X-Key
string
header
required

Body

application/json
filter
GroupNode · object | null

Company or contact conditions selecting distinct companies.

columns
string[] | null

Company fields to write; omitted or empty uses company defaults. ["*"] expands to company catalog fields.

format
string
default:json

File format: csv, json, or parquet; json by default.

compression
string
default:gz

File compression: gz, zip, or none; gz by default.

maxRows
integer | null

Positive integer row cap. Omit or send null to use the service maximum of 1,000,000. Sending 0 returns 422 INVALID_REQUEST.

Required range: x >= 1
filename
string | null

Optional base filename, up to 150 characters. The service adds the format and compression extension.

reveal
string[] | null

Ignored for company files. Company fields do not add contact email or mobile reveal charges.

Response

Successful Response

The response is of type Response Estimate Company Export V1 Company Exports Estimate Post · object.