Query paginated national trade list data — retrieve country-level trade breakdowns with annual, quarterly, and monthly trade volumes for comprehensive market analysis. Enables multi-dimensional country comparison with detailed trade volume decomposition across time periods. Designed for export teams, market researchers and trade analysts who need to compare import-export volumes across countries, analyze market penetration and identify growth opportunities through structured country trade data across 220+ countries and territories.

SKILL.md

---
name: customs-overview-trade-list
description: "Query paginated national trade list data — retrieve country-level trade breakdowns with annual, quarterly, and monthly trade volumes for market analysis.\n\nTrigger: country trade list, paginated trade query, national trade breakdown, import export country comparison, trade volume by country"
metadata: {"version":"1.0.0","homepage":"https://www.upkuajing.com","clawdbot":{"emoji":"📋","requires":{"bins":["python"],"env":["UPKUAJING_API_KEY"]},"primaryEnv":"UPKUAJING_API_KEY"}}
---

# Customs Overview Trade List

Query paginated national trade list data from customs data using the UpKuaJing Open Platform API.

## Overview

This skill provides paginated trade list data from UpKuaJing's customs database. Given an origin country, arrival country, and year, it returns a paginated list of countries with trade statistics including annual, quarterly, and monthly trade volumes, as well as supplier and buyer counts.

## Running Scripts

### Environment Setup

1. **Check Python**: `python --version`
2. **Install dependencies**: `pip install -r requirements.txt`

Script directory: `scripts/*.py`
Run example: `python scripts/*.py`

**Important**: Always use direct script invocation like `python scripts/customs_overview_trade_list.py`. **Do NOT use** shell compound commands like `cd scripts && python customs_overview_trade_list.py`

### Trade List Query (`customs_overview_trade_list.py`)
- **Return granularity**: One record per country
- **Use cases**: Browse through country trade data with detailed statistics, compare trade volumes across countries, analyze market presence
- **Examples**:
  - "List all countries that trade with US from China in 2025"
  - "Show country trade breakdown for CN to US in 2025"
- **Parameters**: See [Trade List API](references/customs-overview-trade-list-api.md)

## API Key and Top-up

This skill requires an API key. The API key is stored in the `~/.upkuajing/.env` file:
```bash
cat ~/.upkuajing/.env
```
**Example file content**:
```
UPKUAJING_API_KEY=your_api_key_here
```
### **API Key Not Set**
First check if the `~/.upkuajing/.env` file has UPKUAJING_API_KEY;
If UPKUAJING_API_KEY is not set, prompt the user to choose:
1. User has one: User provides it (manually add to ~/.upkuajing/.env file)
2. User doesn't have one: You can apply using the interface (`auth.py --new_key`), the new key will be automatically saved to ~/.upkuajing/.env
Wait for user selection;

### **Account Top-up**
When API response indicates insufficient balance, explain and guide user to top up:
1. Create top-up order (`auth.py --new_rec_order`)
2. Based on order response, send payment page URL to user, guide user to open URL and pay, user confirms after successful payment;

### **Get Account Information**
Use this script to get account information for UPKUAJING_API_KEY: `auth.py --account_info`

## API Key and UpKuaJing Account
- Newly applied API key: Register and login at [UpKuaJing Open Platform](https://developer.upkuajing.com/), then bind account

## Fees

**All API calls incur fees**, different interfaces have different billing methods.

**Latest pricing**: Users can visit [Detailed Price Description](https://www.upkuajing.com/web/openapi/price.html)
Or use: `python scripts/auth.py --price_info` (returns complete pricing for all interfaces)

### Query Billing Rules

Billed by **number of calls**, each call returns one page of trade list:
- Each API call incurs a fee
- **Before execution:**
  1. Inform user that this query will incur a fee
  2. Stop, wait for explicit user confirmation in a separate message, then execute script

### Fee Confirmation Principle

**Any operation that incurs fees must first inform and wait for explicit user confirmation. Do not execute in the same message as the notification.**

## Workflow

### Decision Guide

| User Intent | Use API |
|-------------|---------|
| "List countries trading with US from China in 2025" | Trade List Query |
| "Show country-by-country trade breakdown for CN to US" | Trade List Query |
| "Compare trade volumes across different countries" | Trade List Query |

## Usage Examples

### Query Trade List

**User request**: "List countries trading with US from China in 2025"
```bash
python scripts/customs_overview_trade_list.py --params '{"originCountryCode":"CN","arrivalCountryCode":"US","year":2025}'
```

**Query the next page**:
```bash
python scripts/customs_overview_trade_list.py --params '{"originCountryCode":"CN","arrivalCountryCode":"US","year":2025,"cursor":"eyJzdGFydCI6MH0="}'
```

**Query for all origins to US**:
```bash
python scripts/customs_overview_trade_list.py --params '{"arrivalCountryCode":"US","year":2025}'
```

## Error Handling

- **API key invalid/non-existent**: Check `UPKUAJING_API_KEY` in `~/.upkuajing/.env` file
- **Insufficient balance**: Guide user to top up
- **Invalid parameters**: **Must first check the corresponding API documentation in references/ directory**, get correct parameter names and formats from documentation, do not guess

### API Documentation Reference

- Trade List: Check [references/customs-overview-trade-list-api.md](references/customs-overview-trade-list-api.md)

## Best Practices

1. **Check API documentation**:
   - **Before executing queries, must first check the corresponding API reference documentation**
   - Check [references/customs-overview-trade-list-api.md](references/customs-overview-trade-list-api.md)
   - Do not guess parameter names, get accurate parameter names and formats from documentation

2. **Pagination**:
   - Use the `cursor` parameter from the response to fetch the next page
   - If no `cursor` is returned in the response, there are no more pages
   - The cursor is a base64-encoded string

3. **Country codes**:
   - Use ISO 3166-1 alpha-2 country codes (e.g., "CN", "US")
   - `countryCode` in the response is the trading partner country

4. **Cross-skill usage**:
   - Start with **customs-overview-summary** for a high-level overview, then drill into specific country pairs with this skill
   - Use results with **customs-company-stats** for company-level analysis

## Notes
- `year` is the only required parameter
- `sellerCount` and `buyerCount` are the number of distinct suppliers and buyers
- Use `cursor` for pagination — it's a base64-encoded string
- File paths use forward slashes on all platforms
- **Prohibit outputting technical parameter format**: Do not display code-style parameters in responses, convert to natural language
- **Do not** estimate or guess per-call fees — use `python scripts/auth.py --price_info` to get accurate pricing information
- **Do not** guess parameter names, get accurate parameter names and formats from documentation

## Related Skills

Other UpKuaJing skills you might find useful:

- customs-overview-summary — Query trade overview summary (aggregated)
- customs-overview-trend — Query import/export trade trends by month
- customs-overview-top-n — Query top N suppliers or buyers
- customs-overview-us-import — Query US import transaction statistics
- customs-overview-date — Query date reference information
- customs-company-stats — Query company basic trade statistics
- customs-company-trends — Query company trade trends (monthly breakdown)
- customs-company-partner-stats — Query company trade partner distribution
- customs-company-area-stats — Query company trade area statistics (aggregated)
- upkuajing-customs-trade-company-search — Search customs trade companies