Versions in this module Expand all Collapse all v0 v0.1.1 Aug 21, 2026 v0.1.0 Aug 21, 2026 Changes in this version + type BatchOptions struct + ScrapeOptions *ScrapeOptions + Webhook string + type BrandResult map[string]any + type Client struct + func New(apiKey string, opts ...Option) (*Client, error) + func (c *Client) Batch(ctx context.Context, urls []string, opts *BatchOptions, wait *WaitOptions) (*Job, error) + func (c *Client) BatchStatus(ctx context.Context, id string) (*Job, error) + func (c *Client) Brand(ctx context.Context, domain string) (BrandResult, error) + func (c *Client) Crawl(ctx context.Context, rawURL string, opts *CrawlOptions, wait *WaitOptions) (*Job, error) + func (c *Client) CrawlStatus(ctx context.Context, id string) (*Job, error) + func (c *Client) Extract(ctx context.Context, urls []string, opts *ExtractOptions) (*ExtractResult, error) + func (c *Client) Images(ctx context.Context, rawURL string) (*ImagesResult, error) + func (c *Client) Logo(ctx context.Context, domain string, opts *LogoOptions) (BrandResult, error) + func (c *Client) Map(ctx context.Context, rawURL string, opts *MapOptions) (*MapResult, error) + func (c *Client) Markdown(ctx context.Context, rawURL string) (string, error) + func (c *Client) Scrape(ctx context.Context, rawURL string, opts *ScrapeOptions) (*ScrapeResult, error) + func (c *Client) Screenshot(ctx context.Context, rawURL string, opts *ScreenshotOptions) (*ScreenshotResult, error) + func (c *Client) Search(ctx context.Context, query string, opts *SearchOptions) (*SearchResult, error) + func (c *Client) StartBatch(ctx context.Context, urls []string, opts *BatchOptions) (string, error) + func (c *Client) StartCrawl(ctx context.Context, rawURL string, opts *CrawlOptions) (string, error) + func (c *Client) Styleguide(ctx context.Context, domain string) (BrandResult, error) + type CrawlOptions struct + AllowSubdomains bool + ExcludePaths []string + IncludePaths []string + Limit int + MaxDepth int + ScrapeOptions *ScrapeOptions + Webhook string + type Error struct + Code string + Details any + Message string + RequestID string + Status int + func (e *Error) Error() string + func (e *Error) IsAuth() bool + func (e *Error) IsInvalidRequest() bool + func (e *Error) IsOutOfCredits() bool + func (e *Error) IsRetryable() bool + func (e *Error) IsTimeout() bool + type ExtractItem struct + Data map[string]any + Error string + Fields map[string]any + URL string + type ExtractOptions struct + EnableWebSearch bool + MergeEntities bool + PreferStructure bool + Prompt string + Schema map[string]any + ShowConfidence bool + ShowSources bool + type ExtractResult struct + Results []ExtractItem + Sources []any + type Format string + const FormatBrand + const FormatHTML + const FormatJSON + const FormatLinks + const FormatMarkdown + const FormatRawHTML + const FormatStructured + const FormatSummary + type ImagesResult struct + FinalURL string + Images []PageImage + URL string + type Job struct + Completed int + CreditsUsed int + Failed int + ID string + Kind string + Pages []JobPage + SeedURL string + Status string + Total int + func (j *Job) Done() bool + type JobPage struct + Data *ScrapeResult + Depth int + Error string + ErrorCode string + RequestedURL string + Retryable bool + Status string + URL string + type LogoOptions struct + Theme string + Type string + type MapOptions struct + IgnoreQueryParameters bool + IncludeLinks bool + IncludeSubdomains bool + Limit int + Search string + Sitemap string + SitemapExclude []string + SitemapInclude []string + type MapResult struct + Count int + Links []string + Total int + Truncated bool + URL string + type Metadata map[string]any + type Option func(*Client) + func WithBaseURL(u string) Option + func WithHTTPClient(h *http.Client) Option + func WithMaxRetries(n int) Option + func WithTimeout(d time.Duration) Option + type PageImage struct + Alt string + Height int + Src string + Width int + type ScrapeOptions struct + BlockAds bool + CacheOnly bool + ExcludeTags []string + Formats []Format + Headers map[string]string + IncludeLinks bool + IncludeTags []string + MaxAge int + OnlyMainContent bool + PreferStructure bool + RemoveBase64Images bool + StoreInCache *bool + Timeout int + WaitFor int + type ScrapeResult struct + Cached bool + FinalURL string + HTML string + JSON any + Links []string + Markdown string + Metadata Metadata + RawHTML string + Redirected bool + Status int + Structured any + Summary string + URL string + Usage *Usage + Warning string + type ScreenshotOptions struct + FullPage bool + MaxAge int + Timeout int + WaitFor int + type ScreenshotResult struct + Cached bool + FinalURL string + Height int + Screenshot string + ScreenshotType string + Status int + URL string + Width int + type SearchItem struct + Data *ScrapeResult + Rank int + Snippet string + Title string + URL string + type SearchOptions struct + Country string + ExcludeDomains []string + IncludeDomains []string + Limit int + ScrapeOptions *ScrapeOptions + ScrapeResults bool + TimeRange string + type SearchResult struct + Query string + Results []SearchItem + Status string + type Usage struct + CreditsRemaining int + CreditsUsed int + Freshness string + type WaitOptions struct + OnProgress func(*Job) + PollInterval time.Duration + Timeout time.Duration
Go to main page