Versions in this module Expand all Collapse all v0 v0.1.0 Nov 6, 2026 Changes in this version + const APIKeyEnvironmentVariable + const DefaultBaseURL + const DefaultConcurrency + const DefaultRetryDelay + const DefaultTimeout + const MaxRetries + const MaxRetryDelay + const RetryBackoffFactor + const Version + var JobTerminalStatuses = []string + func Bool(v bool) *bool + func Float(v float64) *float64 + func Int(v int64) *int64 + func String(v string) *string + type APIError struct + Message string + Response *Response + StatusCode int + func IsAPIError(err error) (*APIError, bool) + func (e *APIError) Error() string + type AnalyzeParams struct + Cache *bool + CacheTTL *float64 + CustomPrompt *string + CustomResponse *string + Fields *string + IsAsync *bool + Proxy *string + SoftFail *bool + URL string + type BatchResult struct + Err error + Index int + Value T + func Batch[I, T any](ctx context.Context, items []I, concurrency int, ...) []BatchResult[T] + type CaptureParams struct + BlockResources *string + BlockUrls *string + Cache *bool + CacheTTL *float64 + Delay *float64 + Device *string + Fields *string + Format *string + FullPage *bool + FullPageScroll *bool + FullPageScrollDuration *float64 + ImageQuality *string + IsAsync *bool + Proxy *string + RemoveAds *bool + RemoveCookieBanners *bool + RemoveSelectors *string + S3AccessKeyID *string + S3Bucket *string + S3ObjectKey *string + S3Region *string + S3SecretKey *string + S3URL *bool + ScaleFactor *float64 + Selector *string + SoftFail *bool + StorageEndpoint *string + URL string + ViewportHeight *float64 + ViewportWidth *float64 + WaitForSelector *string + WaitUntil []string + type Client struct + func NewClient(apiKey string, options *ClientOptions) (*Client, error) + func (c *Client) Analyze(ctx context.Context, params *AnalyzeParams, options ...RequestOption) (*Response, error) + func (c *Client) Capture(ctx context.Context, params *CaptureParams, options ...RequestOption) (*Response, error) + func (c *Client) Content(ctx context.Context, params *ContentParams, options ...RequestOption) (*Response, error) + func (c *Client) Jobs(ctx context.Context, params *JobsParams, options ...RequestOption) (*Response, error) + func (c *Client) Request(ctx context.Context, method, path string, params map[string]any, ...) (*Response, error) + func (c *Client) Stats(ctx context.Context, params *StatsParams, options ...RequestOption) (*Response, error) + func (c *Client) Usage(ctx context.Context, options ...RequestOption) (*Response, error) + func (c *Client) WaitForJob(ctx context.Context, jobID string, options *WaitForJobOptions) (*Response, error) + func (c *Client) WebsiteCrawler(ctx context.Context, params *WebsiteCrawlerParams, options ...RequestOption) (*Response, error) + type ClientOptions struct + BaseURL string + HTTPClient *http.Client + Headers map[string]string + MaxRetries int + RetryDelay time.Duration + Timeout time.Duration + type ConfigurationError struct + Err error + Message string + func (e *ConfigurationError) Error() string + func (e *ConfigurationError) Unwrap() error + type ContentParams struct + BlockResources *string + BlockUrls *string + Cache *bool + CacheTTL *float64 + Delay *float64 + Fields *string + IncludeHTML *bool + IncludeMarkdown *bool + IncludeSitemap *bool + IsAsync *bool + Proxy *string + RemoveAds *bool + RemoveCookieBanners *bool + RemoveSelectors *string + SoftFail *bool + URL string + UseDefuddle *bool + WaitForSelector *string + WaitUntil []string + type JobTimeoutError struct + JobID string + LastResponse *Response + func (e *JobTimeoutError) Error() string + type JobsParams struct + ID string + type RequestOption func(*requestOptions) + func WithHeader(name, value string) RequestOption + func WithMaxRetries(n int) RequestOption + func WithMethod(method string) RequestOption + type Response struct + Body []byte + ContentType string + Header http.Header + IsJSON bool + StatusCode int + func (r *Response) Decode(v any) error + func (r *Response) Map() (map[string]any, error) + type ResponseDecodingError struct + Err error + Message string + Response *Response + func (e *ResponseDecodingError) Error() string + func (e *ResponseDecodingError) Unwrap() error + type SerializationError struct + Err error + Message string + Param string + func (e *SerializationError) Error() string + func (e *SerializationError) Unwrap() error + type StatsParams struct + Engine *string + Path *string + type TransportError struct + Err error + Message string + func (e *TransportError) Error() string + func (e *TransportError) Unwrap() error + type WaitForJobOptions struct + Interval time.Duration + OnProgress func(job map[string]any) + Timeout time.Duration + type WebsiteCrawlerParams struct + AllowRedirects *bool + Fields *string + IsAsync *bool + Query string + ReturnPageSource *bool + SoftFail *bool