Getting Started

Get up and running with the Heydeo API in minutes.

1. Create an Account

First, sign up for a Heydeo account at app.heydeo.ai/signup

2. Get Your API Key

Once logged in, navigate to Settings → API Keys to generate your API key.

⚠️ Important: Keep your API key secret. Never expose it in client-side code or public repositories.

3. Make Your First Request

Here's a simple cURL example to verify your API key:

curl -X POST https://api.heydeo.ai/v1/shipments/search \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "origin": "US",
    "destination": "CN",
    "hsCode": "8517"
  }'

4. Use an SDK (Recommended)

For production use, we recommend using one of our official SDKs:

JavaScript/TypeScript

npm install @heydeo/sdk
import { HeydeoClient } from '@heydeo/sdk';

const client = new HeydeoClient({
  apiKey: process.env.HEYDEO_API_KEY
});

const shipments = await client.shipments.search({
  origin: 'US',
  destination: 'CN',
  hsCode: '8517'
});

Python

pip install heydeo
from heydeo import HeydeoClient

client = HeydeoClient(api_key='YOUR_API_KEY')

shipments = client.shipments.search(
    origin='US',
    destination='CN',
    hs_code='8517'
)

5. Explore the API

Check out these resources to learn more:

Authentication

All API requests must include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Rate Limits

Our API has the following rate limits:

  • Free tier: 100 requests/hour
  • Pro tier: 1,000 requests/hour
  • Enterprise: Custom limits

See Rate Limits for more details.

🚀 Next Steps