ebay

README

eBay clients for Crawlora

Official Crawlora client packages for the hosted eBay API. Access 10 API endpoints covering listing search, item details, seller profiles, feedback and shops, and eBay Live streams from JavaScript/TypeScript, Python, Go, Ruby, Java, and PHP. These clients call Crawlora's hosted API; they do not scrape eBay 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 eBay or its owners.

Language packages

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

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 10 selected public eBay 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	/ebay/item/{item_id}	ebay-item	Get eBay item details
GET	/ebay/live/streams	ebay-live-streams	List eBay Live streams
GET	/ebay/live/streams/batch	ebay-live-streams-batch	Get multiple eBay Live streams
GET	/ebay/live/streams/{id}	ebay-live-stream	Get an eBay Live stream
GET	/ebay/live/streams/{id}/items	ebay-live-stream-items	List an eBay Live stream's featured items
POST	/ebay/search	ebay-search	Search eBay listings
GET	/ebay/seller/{seller}	ebay-seller	Get eBay seller profile
GET	/ebay/seller/{seller}/about	ebay-seller-about	Get eBay seller about details
GET	/ebay/seller/{seller}/feedback	ebay-seller-feedback	Get eBay seller feedback
GET	/ebay/seller/{seller}/shop	ebay-seller-shop	Get eBay seller shop listings

License

MIT. See LICENSE.

Documentation

Overview

Package ebay is Crawlora's eBay API client for 10 endpoints, covering listing search, item details, seller profiles, feedback and shops, and eBay Live streams. API documentation: https://crawlora.net/docs?utm_source=pkg.go.dev&utm_medium=referral&utm_campaign=platform-clients&utm_content=ebay-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) Close() error
  • func (c *Client) Item(ctx context.Context, params Params) (any, error)
  • func (c *Client) LiveStream(ctx context.Context, params Params) (any, error)
  • func (c *Client) LiveStreamItems(ctx context.Context, params Params) (any, error)
  • func (c *Client) LiveStreams(ctx context.Context, params Params) (any, error)
  • func (c *Client) LiveStreamsBatch(ctx context.Context, params Params) (any, error)
  • func (c *Client) Search(ctx context.Context, params Params) (any, error)
  • func (c *Client) Seller(ctx context.Context, params Params) (any, error)
  • func (c *Client) SellerAbout(ctx context.Context, params Params) (any, error)
  • func (c *Client) SellerFeedback(ctx context.Context, params Params) (any, error)
  • func (c *Client) SellerShop(ctx context.Context, params Params) (any, error)
• type Params

Examples

• Client.Call

Constants

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

const OperationCount = 10

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(), "ebay-item", Params{"item_id": "sample-id"})
if err != nil {
	panic(err)
}
fmt.Println(result.(map[string]any)["ok"])

Output:
true

func (*Client) Close

func (c *Client) Close() error

Close releases idle connections held by the configured HTTP transport.

func (*Client) Item

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

Item calls the ebay-item operation.

func (*Client) LiveStream

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

LiveStream calls the ebay-live-stream operation.

func (*Client) LiveStreamItems

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

LiveStreamItems calls the ebay-live-stream-items operation.

func (*Client) LiveStreams

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

LiveStreams calls the ebay-live-streams operation.

func (*Client) LiveStreamsBatch

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

LiveStreamsBatch calls the ebay-live-streams-batch operation.

func (*Client) Search

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

Search calls the ebay-search operation.

func (*Client) Seller

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

Seller calls the ebay-seller operation.

func (*Client) SellerAbout

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

SellerAbout calls the ebay-seller-about operation.

func (*Client) SellerFeedback

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

SellerFeedback calls the ebay-seller-feedback operation.

func (*Client) SellerShop

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

SellerShop calls the ebay-seller-shop operation.

type Params

type Params map[string]any

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