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.

• JavaScript / TypeScript: @crawlora-org/bbb
• Python: crawlora-bbb
• Go: github.com/Crawlora-org/crawlora-bbb
• Ruby: crawlora-bbb
• Java: net.crawlora:crawlora-bbb:0.1.2
• PHP: crawlora/bbb
• API endpoint and parameter reference
• Runnable examples
• Package repository

Create an account at crawlora.net, open the Crawlora console to get an API key, or read the API documentation.

Install

npm install @crawlora-org/bbb
python -m pip install crawlora-bbb
go get github.com/Crawlora-org/crawlora-bbb@latest
gem install crawlora-bbb
composer require crawlora/bbb

For Java, add net.crawlora:crawlora-bbb:0.1.2 to your Maven dependencies; see java/README.md.

Set your API key before running a client:

export CRAWLORA_API_KEY="your-crawlora-api-key"

Do not commit API keys. See each language README for runnable usage examples.

PHP example

composer require crawlora/bbb

<?php
require __DIR__ . '/vendor/autoload.php';

$apiKey = getenv('CRAWLORA_API_KEY');
if (!$apiKey) throw new RuntimeException('Set CRAWLORA_API_KEY before running this example.');
$client = new \Crawlora\Bbb\Client(apiKey: $apiKey);
$result = $client->request("bbb-search", ['query' => 'coffee', 'location' => 'New York, NY']);
print_r($result);
$client->close();

API coverage

The six clients provide access to 9 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) 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) 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)
• type Params

Constants

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

const OperationCount = 9

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) 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.

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) 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.

type Params

type Params map[string]any

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