bbb

README

Better Business Bureau clients for Crawlora

Official Crawlora client packages for the hosted Better Business Bureau API. These clients call Crawlora's hosted API; they do not scrape Better Business Bureau locally. Requests use your Crawlora account and CRAWLORA_API_KEY; service usage follows your account billing plan. Crawlora is independent from and not affiliated with or endorsed by Better Business Bureau or its owners.

Language packages

• JavaScript / TypeScript: @crawlora-org/bbb
• Python: crawlora-bbb
• Go: github.com/Crawlora-org/crawlora-bbb
• Ruby: crawlora-bbb
• Java: net.crawlora:crawlora-bbb:0.3.0
• PHP: crawlora/bbb

For installation and runnable examples, use the README for your language. See the API endpoint and parameter reference for shared operation details.

Create an account at crawlora.net, open the Crawlora console to get an API key, or read the API documentation. Keep CRAWLORA_API_KEY out of source control.

API coverage

The six clients provide access to 16 public API operations. See the API reference for supported operations, parameters, and response details.

License

MIT. See LICENSE.

Documentation

Overview

Package bbb is a focused Go client for Crawlora's Better Business Bureau endpoints. API documentation: https://crawlora.net/docs?utm_source=pkg.go.dev&utm_medium=referral&utm_campaign=platform-clients&utm_content=bbb-go-api-docs

Index

• Constants
• func OperationIDs() []string
• type Client
  • func NewClient(apiKey string) *Client
  • func (c *Client) Article(ctx context.Context, params Params) (any, error)
  • func (c *Client) Business(ctx context.Context, params Params) (any, error)
  • func (c *Client) BusinessComplaints(ctx context.Context, params Params) (any, error)
  • func (c *Client) BusinessMoreInfo(ctx context.Context, params Params) (any, error)
  • func (c *Client) BusinessReviews(ctx context.Context, params Params) (any, error)
  • func (c *Client) Call(ctx context.Context, operationID string, params Params) (any, error)
  • func (c *Client) Category(ctx context.Context, params Params) (any, error)
  • func (c *Client) Close() error
  • func (c *Client) LocalBbb(ctx context.Context, params Params) (any, error)
  • func (c *Client) LocalBbbs(ctx context.Context, params Params) (any, error)
  • func (c *Client) News(ctx context.Context, params Params) (any, error)
  • func (c *Client) NewsTopics(ctx context.Context, params Params) (any, error)
  • func (c *Client) Regions(ctx context.Context, params Params) (any, error)
  • func (c *Client) ScamtrackerDetail(ctx context.Context, params Params) (any, error)
  • func (c *Client) ScamtrackerSearch(ctx context.Context, params Params) (any, error)
  • func (c *Client) ScamtrackerStateStats(ctx context.Context, params Params) (any, error)
  • func (c *Client) Search(ctx context.Context, params Params) (any, error)
  • func (c *Client) SearchFilters(ctx context.Context, params Params) (any, error)
• type Params

Examples

• Client.Call

Constants

const (
	DefaultBaseURL = "https://api.crawlora.net/api/v1"
	Version        = "0.3.0"
)

const OperationCount = 16

OperationCount reports how many selected-platform operations this module exposes.

Functions

func OperationIDs

func OperationIDs() []string

OperationIDs returns the selected operation IDs in stable sorted order.

Types

type Client

type Client struct {
	APIKey     string
	BaseURL    string
	Timeout    time.Duration
	HTTPClient *http.Client
}

Client calls only the operation IDs included in this platform module.

func NewClient

func NewClient(apiKey string) *Client

NewClient creates a client using the supplied API key, or CRAWLORA_API_KEY when empty.

func (*Client) Article

func (c *Client) Article(ctx context.Context, params Params) (any, error)

Article calls the bbb-article operation.

func (*Client) Business

func (c *Client) Business(ctx context.Context, params Params) (any, error)

Business calls the bbb-business operation.

func (*Client) BusinessComplaints

func (c *Client) BusinessComplaints(ctx context.Context, params Params) (any, error)

BusinessComplaints calls the bbb-business-complaints operation.

func (*Client) BusinessMoreInfo

func (c *Client) BusinessMoreInfo(ctx context.Context, params Params) (any, error)

BusinessMoreInfo calls the bbb-business-more-info operation.

func (*Client) BusinessReviews

func (c *Client) BusinessReviews(ctx context.Context, params Params) (any, error)

BusinessReviews calls the bbb-business-reviews operation.

func (*Client) Call

func (c *Client) Call(ctx context.Context, operationID string, params Params) (any, error)

Call executes a selected platform operation by operation ID.

Example

server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
	w.Header().Set("Content-Type", "application/json")
	_, _ = w.Write([]byte(`{"ok":true}`))
}))
defer server.Close()

client := NewClient("your-crawlora-api-key")
client.BaseURL = server.URL + "/api/v1"
client.HTTPClient = server.Client()
result, err := client.Call(context.Background(), "bbb-article", Params{"url": "sample"})
if err != nil {
	panic(err)
}
fmt.Println(result.(map[string]any)["ok"])

Output:
true

func (*Client) Category

func (c *Client) Category(ctx context.Context, params Params) (any, error)

Category calls the bbb-category operation.

func (*Client) Close

func (c *Client) Close() error

Close releases idle connections held by the configured HTTP transport.

func (*Client) LocalBbb

func (c *Client) LocalBbb(ctx context.Context, params Params) (any, error)

LocalBbb calls the bbb-local-bbb operation.

func (*Client) LocalBbbs

func (c *Client) LocalBbbs(ctx context.Context, params Params) (any, error)

LocalBbbs calls the bbb-local-bbbs operation.

func (*Client) News

func (c *Client) News(ctx context.Context, params Params) (any, error)

News calls the bbb-news operation.

func (*Client) NewsTopics

func (c *Client) NewsTopics(ctx context.Context, params Params) (any, error)

NewsTopics calls the bbb-news-topics operation.

func (*Client) Regions

func (c *Client) Regions(ctx context.Context, params Params) (any, error)

Regions calls the bbb-regions operation.

func (*Client) ScamtrackerDetail

func (c *Client) ScamtrackerDetail(ctx context.Context, params Params) (any, error)

ScamtrackerDetail calls the bbb-scamtracker-detail operation.

func (*Client) ScamtrackerSearch

func (c *Client) ScamtrackerSearch(ctx context.Context, params Params) (any, error)

ScamtrackerSearch calls the bbb-scamtracker-search operation.

func (*Client) ScamtrackerStateStats

func (c *Client) ScamtrackerStateStats(ctx context.Context, params Params) (any, error)

ScamtrackerStateStats calls the bbb-scamtracker-state-stats operation.

func (*Client) Search

func (c *Client) Search(ctx context.Context, params Params) (any, error)

Search calls the bbb-search operation.

func (*Client) SearchFilters

func (c *Client) SearchFilters(ctx context.Context, params Params) (any, error)

SearchFilters calls the bbb-search-filters operation.

type Params

type Params map[string]any

Params maps the exact OpenAPI parameter names expected by this platform client.