firecrawl

package module

Go to main page

Versions in this module

v1

v1.0.0

Aug 29, 2024

Changes in this version

+ type CrawlParams struct

+ AllowBackwardLinks *bool

+ AllowExternalLinks *bool

+ ExcludePaths []string

+ IgnoreSitemap *bool

+ IncludePaths []string

+ Limit *int

+ MaxDepth *int

+ ScrapeOptions ScrapeParams

+ Webhook *string

type CrawlResponse

+ ID string

+ URL string

+ type CrawlStatusResponse struct

+ Completed int

+ CreditsUsed int

+ Data []*FirecrawlDocument

+ ExpiresAt string

+ Next *string

+ Status string

+ Total int

type FirecrawlApp

+ Version string

+ func (app *FirecrawlApp) AsyncCrawlURL(url string, params *CrawlParams, idempotencyKey *string) (*CrawlResponse, error)

+ func (app *FirecrawlApp) MapURL(url string, params *MapParams) (*MapResponse, error)

type FirecrawlDocument

+ Links []string

+ RawHTML string

+ Screenshot string

type FirecrawlDocumentMetadata

+ Error *string

+ StatusCode *int

+ type MapParams struct

+ IgnoreSitemap *bool

+ IncludeSubdomains *bool

+ Limit *int

+ Search *string

+ type MapResponse struct

+ Error string

+ Links []string

+ Success bool

+ type ScrapeParams struct

+ ExcludeTags []string

+ Formats []string

+ Headers *map[string]string

+ IncludeTags []string

+ OnlyMainContent *bool

+ ParsePDF *bool

+ Timeout *int

+ WaitFor *int

v0

v0.0.1

Aug 15, 2024

Changes in this version

+ type CancelCrawlJobResponse struct

+ Status string

+ Success bool

+ type CrawlResponse struct

+ Data []*FirecrawlDocument

+ JobID string

+ Success bool

+ type ExtractorOptions struct

+ ExtractionPrompt string

+ ExtractionSchema any

+ Mode string

+ type FirecrawlApp struct

+ APIKey string

+ APIURL string

+ Client *http.Client

+ func NewFirecrawlApp(apiKey, apiURL string) (*FirecrawlApp, error)

+ func (app *FirecrawlApp) CancelCrawlJob(jobID string) (string, error)

+ func (app *FirecrawlApp) CheckCrawlStatus(jobID string) (*JobStatusResponse, error)

+ func (app *FirecrawlApp) CrawlURL(url string, params map[string]any, waitUntilDone bool, pollInterval int, ...) (any, error)

+ func (app *FirecrawlApp) ScrapeURL(url string, params map[string]any) (*FirecrawlDocument, error)

+ func (app *FirecrawlApp) Search(query string, params map[string]any) ([]*FirecrawlDocument, error)

+ type FirecrawlDocument struct

+ ChildrenLinks []string

+ Content string

+ CreatedAt *time.Time

+ HTML string

+ ID string

+ Index int

+ LLMExtraction map[string]any

+ Markdown string

+ Metadata *FirecrawlDocumentMetadata

+ Provider string

+ Type string

+ URL string

+ UpdatedAt *time.Time

+ Warning string

+ type FirecrawlDocumentMetadata struct

+ ArticleSection string

+ ArticleTag string

+ DCDate string

+ DCDateCreated string

+ DCDescription string

+ DCSubject string

+ DCTermsAudience string

+ DCTermsCreated string

+ DCTermsKeywords string

+ DCTermsSubject string

+ DCTermsType string

+ DCType string

+ Description string

+ Keywords string

+ Language string

+ ModifiedTime string

+ OGAudio string

+ OGDescription string

+ OGDeterminer string

+ OGImage string

+ OGLocale string

+ OGLocaleAlternate []string

+ OGSiteName string

+ OGTitle string

+ OGURL string

+ OGVideo string

+ PageError string

+ PageStatusCode int

+ PublishedTime string

+ Robots string

+ SourceURL string

+ Title string

+ type JobStatusResponse struct

+ Current int

+ CurrentStep string

+ CurrentURL string

+ Data []*FirecrawlDocument

+ JobID string

+ PartialData []*FirecrawlDocument

+ Status string

+ Success bool

+ Total int

+ type ScrapeResponse struct

+ Data *FirecrawlDocument

+ Success bool

+ type SearchResponse struct

+ Data []*FirecrawlDocument

+ Success bool

Other modules containing this package

github.com/mendableai/firecrawl-go/v2

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL