amazon

README

Amazon clients for Crawlora

Official Crawlora client packages for the hosted Amazon API. Access 5 API endpoints covering product search, suggestions, product details, and chart/category discovery from JavaScript/TypeScript, Python, Go, Ruby, Java, and PHP. These clients call Crawlora's hosted API; they do not scrape Amazon 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 Amazon or its owners.

Language packages

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

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 and supported endpoints

The six language clients provide access to all 5 selected public Amazon API operations. Search or browse by endpoint path and operation ID below; the complete API reference adds parameters, enums, and response details.

Method	Endpoint	API operation	Description
GET	/amazon/charts	amazon-charts	Amazon product charts
GET	/amazon/charts/categories	amazon-charts-categories	Amazon chart categories
GET	/amazon/product/{asin}	amazon-product	Retrieve Amazon product details
GET	/amazon/search	amazon-search	Search Amazon products
GET	/amazon/suggest/{keyword}	amazon-suggest	Retrieve Amazon search suggestions

License

MIT. See LICENSE.

Documentation

Overview

Package amazon is Crawlora's Amazon API client for 5 endpoints, covering product search, suggestions, product details, and chart/category discovery. API documentation: https://crawlora.net/docs?utm_source=pkg.go.dev&utm_medium=referral&utm_campaign=platform-clients&utm_content=amazon-go-api-docs

Index

• Constants
• func OperationIDs() []string
• type Client
  • func NewClient(apiKey string) *Client
  • func (c *Client) Call(ctx context.Context, operationID string, params Params) (any, error)
  • func (c *Client) Charts(ctx context.Context, params Params) (any, error)
  • func (c *Client) ChartsCategories(ctx context.Context, params Params) (any, error)
  • func (c *Client) Close() error
  • func (c *Client) Product(ctx context.Context, params Params) (any, error)
  • func (c *Client) Search(ctx context.Context, params Params) (any, error)
  • func (c *Client) Suggest(ctx context.Context, params Params) (any, error)
• type Params

Examples

• Client.Call

Constants

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

const OperationCount = 5

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) 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(), "amazon-charts", Params{"chart": "best_sellers", "department": "sample"})
if err != nil {
	panic(err)
}
fmt.Println(result.(map[string]any)["ok"])

Output:
true

func (*Client) Charts

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

Charts calls the amazon-charts operation.

func (*Client) ChartsCategories

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

ChartsCategories calls the amazon-charts-categories operation.

func (*Client) Close

func (c *Client) Close() error

Close releases idle connections held by the configured HTTP transport.

func (*Client) Product

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

Product calls the amazon-product operation.

func (*Client) Search

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

Search calls the amazon-search operation.

func (*Client) Suggest

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

Suggest calls the amazon-suggest operation.

type Params

type Params map[string]any

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