Skip to main content Module generated Copy item path Source defaults Generation of default values for serde. error Error types. BatchAcceptedDto BatchAcceptedDtoBatchRequestDto BatchRequestDtoBrandAddressDto BrandAddressDtoBrandAssetDto BrandAssetDtoBrandBatchDto BrandBatchDtoBrandBatchResponseDto BrandBatchResponseDtoBrandColorDto BrandColorDtoBrandFieldProvenanceDto BrandFieldProvenanceDtoBrandFontDto BrandFontDtoBrandLinksDto BrandLinksDtoBrandLogoResponseDto BrandLogoResponseDtoBrandNaicsDto BrandNaicsDtoBrandNaicsSectorDto BrandNaicsSectorDtoBrandResolutionDto BrandResolutionDtoBrandResponseDto BrandResponseDtoBrandSearchResponseDto BrandSearchResponseDtoBrandSearchResultDto BrandSearchResultDtoBrandSocialDto BrandSocialDtoCallAcceptedDto CallAcceptedDtoCallJobErrorDto CallJobErrorDtoCallJobStateDto CallJobStateDtoCrawlAcceptedDto CrawlAcceptedDtoCrawlPageResultDto CrawlPageResultDtoCrawlRequestDto CrawlRequestDtoCrawlStatusEnvelopeDto CrawlStatusEnvelopeDtoCrawlStatusResponseDto CrawlStatusResponseDtoExtractItemResultDto ExtractItemResultDtoExtractRequestDto ExtractRequestDtoExtractRequestDtoPrompt Natural-language instruction for what to extract. Use with or instead of a schema. ExtractResponseDto ExtractResponseDtoExtractResultDto ExtractResultDtoFieldProvenanceDto FieldProvenanceDtoImagesRequestDto ImagesRequestDtoImagesResponseDto ImagesResponseDtoJobsIndexChangePostingDto JobsIndexChangePostingDtoJobsIndexChangesRequestDto JobsIndexChangesRequestDtoJobsIndexChangesResponseDto JobsIndexChangesResponseDtoJobsIndexCompanyChangesDto JobsIndexCompanyChangesDtoJobsIndexCountsDto JobsIndexCountsDtoJobsIndexJobDto JobsIndexJobDtoJobsIndexPayDto JobsIndexPayDtoJobsIndexSearchRequestDto JobsIndexSearchRequestDtoJobsIndexSearchRequestDtoLocation A city, region or country the job location must mention. JobsIndexSearchRequestDtoQuery Words to find in the job title. Every word must appear. JobsIndexSearchResponseDto JobsIndexSearchResponseDtoJsonOptionsDto JsonOptionsDtoJsonOptionsDtoPrompt Natural-language instruction for the json format. Use with or instead of a schema. LocationDto LocationDtoLogoDescriptionDto LogoDescriptionDtoMapRequestDto MapRequestDtoMapRequestDtoSearch Keep only discovered URLs containing this term. MapRequestDtoSitemapExclude Skip sub-sitemaps whose URL contains any of these comma-separated terms (case-insensitive). Compose with sitemapInclude — e.g. include “post” + exclude “tag,category,author” avoids WordPress taxonomy sitemaps (post_tag-sitemap, …-taxonomies-post_tag-*) that also contain “post”. MapRequestDtoSitemapInclude On sitemap-index sites, only descend into sub-sitemaps whose URL contains one of these comma-separated terms (case-insensitive). E.g. “post” to target article sitemaps. MapResponseDto MapResponseDtoMapResultDto MapResultDtoMapUrlEntryDto MapUrlEntryDtoMergedEntityDto MergedEntityDtoNewsRequestDto NewsRequestDtoNewsRequestDtoQuery What to find news about. NewsResponseDto NewsResponseDtoNewsResultDto NewsResultDtoNewsResultItemDto NewsResultItemDtoResultFeedbackDataDto ResultFeedbackDataDtoResultFeedbackDto ResultFeedbackDtoResultFeedbackDtoNote More detail, in your own words. ResultFeedbackResponseDto ResultFeedbackResponseDtoScrapeFormatRequestDto ScrapeFormatRequestDtoScrapeFormatRequestDtoBody Request body, sent verbatim. Only used when method is POST. Set the content type yourself via headers; nothing is assumed about the format. ScrapeOptionsDto ScrapeOptionsDtoScrapeRequestDto ScrapeRequestDtoScrapeRequestDtoBody Request body, sent verbatim. Only used when method is POST. Set the content type yourself via headers; nothing is assumed about the format. ScrapeResponseDto ScrapeResponseDtoScrapeStatusResponseDto ScrapeStatusResponseDtoScreenshotRequestDto ScreenshotRequestDtoScreenshotResponseDto ScreenshotResponseDtoSearchRequestDto SearchRequestDtoSearchRequestDtoQuery What to search the web for. SearchResponseDto SearchResponseDtoSearchResultDto SearchResultDtoSearchResultItemDto SearchResultItemDtoStyleguideBandDto StyleguideBandDtoStyleguideButtonBorderDto StyleguideButtonBorderDtoStyleguideButtonDto StyleguideButtonDtoStyleguideColorDto StyleguideColorDtoStyleguideComponentsDto StyleguideComponentsDtoStyleguideContrastDto StyleguideContrastDtoStyleguideDarkButtonDto StyleguideDarkButtonDtoStyleguideDarkDto StyleguideDarkDtoStyleguideDecorationDto StyleguideDecorationDtoStyleguideFontDto StyleguideFontDtoStyleguideFontUsageDto StyleguideFontUsageDtoStyleguideHeaderBorderDto StyleguideHeaderBorderDtoStyleguideHeaderDto StyleguideHeaderDtoStyleguidePanelBorderDto StyleguidePanelBorderDtoStyleguidePanelDto StyleguidePanelDtoStyleguideRadiusDto StyleguideRadiusDtoStyleguideResponseDto StyleguideResponseDtoStyleguideTabDto StyleguideTabDtoStyleguideTabsDto StyleguideTabsDtoStyleguideWebfontDto StyleguideWebfontDtoWebBrandDataDto WebBrandDataDtoWebBrandSearchDataDto WebBrandSearchDataDtoWebError Every failure on this API returns this shape, whatever the status. Successful responses never carry it. WebErrorBody WebErrorBodyWebErrorMeta WebErrorMetaWebImageDto WebImageDtoWebImagesDataDto WebImagesDataDtoWebLinksDto WebLinksDtoWebQualityDto WebQualityDtoWebScrapeDataDto WebScrapeDataDtoWebScrapeMetadataDto WebScrapeMetadataDtoWebScreenshotDataDto WebScreenshotDataDtoWebStructuredDataDto WebStructuredDataDtoWebStructuredEntityDto WebStructuredEntityDtoWebStyleguideDataDto WebStyleguideDataDtoWebUsageDto WebUsageDtoWebhookDeliveriesResponseDto WebhookDeliveriesResponseDtoWebhookDeliveryDto WebhookDeliveryDtoWebhookDto WebhookDtoWebhookDtoSecret A shared secret. When set, each callback carries an X-Hydrafetch-Signature header you can verify to prove the request came from us and is not a replay. BatchAcceptedDtoStatus The job has been accepted. BrandAssetDtoKind What kind of mark this is. BrandAssetDtoVariant Which background the asset is legible on. mono is a single-colour mark that works on both. BrandColorDtoRole BrandColorDtoRoleBrandFieldProvenanceDtoSource declared the site said it in its own markup. harvested we processed an asset or read its CSS. inferred we worked it out rather than read it, such as a name taken from the domain. external an enrichment source rather than the site.BrandFontDtoRole Absent when the page does not say which the face is. BrandNaicsDtoLevel How specific the answer is. industry_group is the 4-digit level, national_industry the 6-digit one. CallAcceptedDtoStatus CallAcceptedDtoStatusCallJobStateDtoStatus CallJobStateDtoStatusCrawlAcceptedDtoStatus The job has been accepted. CrawlPageResultDtoDiscoveredVia How this URL entered the job. requested is a URL you gave us, meaning the crawl seed or a batch entry. sitemap came from the site’s sitemap, link from following a link on a page we had already fetched. CrawlPageResultDtoStatus State of this page. CrawlRequestDtoSitemap Whether to seed discovery from the site’s published page list. Default includes it. CrawlStatusResponseDtoKind Which kind of job this is. CrawlStatusResponseDtoStatus Overall job state. LogoDescriptionDtoVariant LogoDescriptionDtoVariantMapRequestDtoOrder Sort order by sitemap lastmod. “newest” (default) returns the most recent URLs first — the wanted end of a large archive under the limit. URLs without a lastmod sort last. MapRequestDtoSitemap Whether to use the site’s published page list: skip it, include it alongside discovered links, or use it only. NewsRequestDtoTimeRange Only articles published within this window before now. NewsResultDtoStatus ok when articles were found, no_results when none matched in the window. If news cannot be searched at all, the request fails with 503 rather than returning an empty list.ResultFeedbackDataDtoRating ResultFeedbackDataDtoRatingResultFeedbackDtoRating Whether the result was accurate. ResultFeedbackDtoReasonsItem ResultFeedbackDtoReasonsItemScrapeFormatRequestDtoMethod HTTP method to fetch the URL with. Use POST for endpoints that only answer a POST, such as JSON and GraphQL APIs. Defaults to GET. ScrapeOptionsDtoFormatsItem ScrapeOptionsDtoFormatsItemScrapeRequestDtoFormatsItem ScrapeRequestDtoFormatsItemScrapeRequestDtoMethod HTTP method to fetch the URL with. Use POST for endpoints that only answer a POST, such as JSON and GraphQL APIs. Defaults to GET. ScrapeStatusResponseDtoStatus Job state. ScreenshotRequestDtoViewport Screen size to render at. Defaults to desktop (1920x1080). Ignored when width/height are given explicitly. SearchRequestDtoTimeRange Restrict results to a recency window relative to now. SearchResultDtoStatus Whether the search found anything: ok when it returned results, no_results when the web had no match. An empty results with no_results is a real miss — if the search cannot be completed at all, the request fails with 503 rather than returning an empty list. StyleguideColorDtoRole Roles rather than a ranked list, so a colour drops straight into a theme instead of leaving you to guess which one is safe behind text. StyleguideComponentsDtoHeadingOnPanel Where a panel’s title sits: across its top border like a fieldset legend, inside its padding, or just above it. StyleguideDecorationDtoKind A layer the site draws behind or beside its panels: a patterned image, a solid block or an outline, offset to read as a shadow. StyleguideFontDtoRole StyleguideFontDtoRoleStyleguideWebfontDtoType StyleguideWebfontDtoTypeWebErrorBodyCode Stable, machine-readable reason. Branch on this rather than on the message, which may be reworded. WebScrapeMetadataDtoStructure Whether the content carries markdown structure (headings, lists, emphasis) or is plain prose. plain is not an error — the default extractor optimises for capturing every word and wins on listing and forum pages. If you need the structure, re-request with preferStructure: true. WebScreenshotDataDtoScreenshotType Whether the capture covers the whole scrollable page or just the viewport. WebStructuredEntityDtoSource Which structured-data syntax the entity came from. WebStyleguideDataDtoMode Whether the page as first loaded is light or dark. colors describe this mode. WebUsageDtoFreshness Whether the result was served from cache or freshly fetched. WebhookDeliveryDtoStatus pending while retries remain, success once delivered, failed once given up. WebhookDtoEventsItem WebhookDtoEventsItem