Quickstart

Make your first authenticated API call on Hello Tractor — either financial services (lending and payments) or Marketplace (tractors and field operations).

Choose your API

Financial services quickstart

1. List contracts

curl -G https://api.hellotractor.com/payg/lms/contracts \
  -H "Authorization: Bearer {your_api_key}" \
  -d page=1 \
  -d limit=10

2. List payment requests for a billing week

curl -G https://api.hellotractor.com/payg/lms/payment-requests \
  -H "Authorization: Bearer {your_api_key}" \
  -d start_date_gte=2025-05-01 \
  -d end_date_lte=2025-05-31

Read the Financial services overview for the PAYG billing flow and Contracts for the full contract model.

Marketplace quickstart

1. Install the SDK (optional)

npm install hello-tractor-sdk --save

The SDK today focuses on Marketplace endpoints; financial services are available via REST with broader SDK support on the roadmap.

2. List tractors

curl -G https://api.hellotractor.com/v1/tractors \
  -H "Authorization: Bearer {your_api_key}" \
  -d limit=10

import { HTSDK } from 'hello-tractor-sdk'

const sdk = HTSDK.init(process.env.HT_API_KEY)
const tractors = await sdk.getAvailableTractors()

See Tractors for the full reference.

Next steps

• Authentication — Keys, OAuth, and security
• Pagination — List endpoints
• Webhooks — Event notifications
• Collaborate — Apply for expanded access