airbnb

README

Airbnb clients for Crawlora

Official Crawlora client packages for the hosted Airbnb API. Access 7 API endpoints covering listing search, room details, calendars and reviews, and host profiles, listings and reviews from JavaScript/TypeScript, Python, Go, Ruby, Java, and PHP. These clients call Crawlora's hosted API; they do not scrape Airbnb 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 Airbnb or its owners.

Language packages

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

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 7 selected public Airbnb 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	/airbnb/host/{id}	airbnb-host	Get Airbnb host profile
GET	/airbnb/host/{id}/listings	airbnb-host-listings	Get Airbnb host listings
GET	/airbnb/host/{id}/reviews	airbnb-host-reviews	Get Airbnb host reviews
GET	/airbnb/room/{id}	airbnb-room	Get Airbnb room
GET	/airbnb/room/{id}/calendar	airbnb-room-calendar	Get Airbnb room calendar
GET	/airbnb/room/{id}/reviews	airbnb-room-reviews	Get Airbnb room reviews
GET	/airbnb/search	airbnb-search	Search Airbnb stays

License

MIT. See LICENSE.

Documentation

Overview

Package airbnb is Crawlora's Airbnb API client for 7 endpoints, covering listing search, room details, calendars and reviews, and host profiles, listings and reviews. API documentation: https://crawlora.net/docs?utm_source=pkg.go.dev&utm_medium=referral&utm_campaign=platform-clients&utm_content=airbnb-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) Host(ctx context.Context, params Params) (any, error)
  • func (c *Client) HostListings(ctx context.Context, params Params) (any, error)
  • func (c *Client) HostReviews(ctx context.Context, params Params) (any, error)
  • func (c *Client) Room(ctx context.Context, params Params) (any, error)
  • func (c *Client) RoomCalendar(ctx context.Context, params Params) (any, error)
  • func (c *Client) RoomReviews(ctx context.Context, params Params) (any, error)
  • func (c *Client) Search(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 = 7

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(), "airbnb-host", Params{"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) Host

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

Host calls the airbnb-host operation.

func (*Client) HostListings

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

HostListings calls the airbnb-host-listings operation.

func (*Client) HostReviews

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

HostReviews calls the airbnb-host-reviews operation.

func (*Client) Room

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

Room calls the airbnb-room operation.

func (*Client) RoomCalendar

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

RoomCalendar calls the airbnb-room-calendar operation.

func (*Client) RoomReviews

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

RoomReviews calls the airbnb-room-reviews operation.

func (*Client) Search

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

Search calls the airbnb-search operation.

type Params

type Params map[string]any

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