Skip to main content
Superdata returns different response shapes for metadata tools and execution.

Capability discovery

superdata_search_capabilities returns categories, a match count, and matching capabilities. Each capability has an exact name that can be passed to superdata_get_capability. Inspection returns the capability method, path template, path parameters, read-only status, execution tool, and credit cost. These two metadata steps do not consume credits.

Successful execution

superdata_call returns: The structure inside data depends on the selected capability. Do not assume that every operation returns company or person records with the same fields.

Missing values

Provider fields can be absent or use JSON null. A missing email, phone, website, location, or metric means a provider value was unavailable; it does not mean the value is a verified negative.

Large and paginated responses

When truncated is true, reduce the requested scope, lower the provider page size, or use pagination supported by that specific capability. Pagination fields are provider- and operation-specific; do not invent a cursor or reuse a token with a different operation.

Errors

An unsuccessful execution returns ok: false with an error code, message, and optional upstream statusCode. Failed provider execution restores the reserved credit. See Errors and limits for safe recovery steps.

Result provenance and responsible use

Results contain external company, professional, application, social, contact, or technology information. Review important records before using them for outreach or operational decisions, and follow applicable privacy, marketing, and data-protection rules.