Customs Analysis Trade Percent
Query trade percentage data from customs data using the UpKuaJing Open Platform API.
Overview
This skill provides company-level trade percentage data for a specified HS code. Given an HS code, country type (exporter/importer), and recent months, it returns a ranked list of companies with their trade counts, percentages, quantities, amounts, and partner counts.
Running Scripts
Environment Setup
- Check Python:
python --version - 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_analysis_trade_percent.py. Do NOT use shell compound commands like cd scripts && python customs_analysis_trade_percent.py
Trade Percent Query (customs_analysis_trade_percent.py)
- Return granularity: One record per company, ranked by trade share
- Use cases: Identify major companies trading a specific product, analyze market concentration, find trade partners
- Examples:
- "Show company trade share for HS code 04021000"
- "Which companies export product 04021000 the most?"
- "What is the market concentration for product 04021000?"
- Parameters: See Trade Percent API
API Key and Top-up
This skill requires an API key. The API key is stored in the ~/.upkuajing/.env file:
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:
- User has one: User provides it (manually add to ~/.upkuajing/.env file)
- 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:
- Create top-up order (
auth.py --new_rec_order) - 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, then bind account
Fees
All API calls incur fees, different interfaces have different billing methods.
Latest pricing: Users can visit Detailed Price Description
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 percentage data:
- Each API call incurs a fee
- Before execution:
- Inform user that this query will incur a fee
- 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 | |-------------|---------| | "Show company trade share for HS code 04021000" | Trade Percent Query | | "Which companies export product 04021000 the most?" | Trade Percent Query | | "What is the market concentration for product 04021000?" | Trade Percent Query |
Usage Examples
Query Trade Percent
User request: "Show company trade share for HS code 04021000 in exporting countries over 12 months"
python scripts/customs_analysis_trade_percent.py --params '{"hscode":"04021000","countryType":1,"recentMonths":12}'
Query importing companies for a specific country:
python scripts/customs_analysis_trade_percent.py --params '{"hscode":"04021000","countryCode":"CN","countryType":2,"recentMonths":12}'
Query the next page:
python scripts/customs_analysis_trade_percent.py --params '{"hscode":"04021000","countryType":1,"recentMonths":12,"cursor":"eyJpZCI6MX0="}'
Error Handling
- API key invalid/non-existent: Check
UPKUAJING_API_KEYin~/.upkuajing/.envfile - 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 Percent: Check references/customs-analysis-trade-percent-api.md
Best Practices
-
Check API documentation:
- Before executing queries, must first check the corresponding API reference documentation
- Check references/customs-analysis-trade-percent-api.md
- Do not guess parameter names, get accurate parameter names and formats from documentation
-
Country type:
countryType=1means exporting companies (suppliers)countryType=2means importing companies (buyers)
-
Cross-skill usage:
- First use customs-analysis-hscode-search and customs-analysis-hscode-detail to find and understand HS codes
- Use customs-analysis-area for geographic distribution, then this skill for company-level breakdown
- Found company IDs can be used with customs-company-stats or customs-company-trends for detailed company analysis
Notes
hscode,countryType, andrecentMonthsare required parameterscountryCodeis optional — omit for global company breakdownrnis the rank number (1 = highest trade share)percentTradeis the company's trade percentage of total- 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_infoto 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-analysis-area — Query trade area distribution by HS code
- customs-analysis-trends — Query import/export trade trends by HS code
- customs-analysis-hscode-search — Search HS codes by product name and keywords
- customs-analysis-hscode-detail — Query HS code detail descriptions
- 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-product-list — Query company product list
- customs-company-area-stats — Query company trade area statistics (aggregated)
- upkuajing-customs-trade-company-search — Search customs trade companies
Scan to join WeChat group