shield_lock
JinDaGe
← Back to skills
extension
Category: Data & AnalyticsAPI key required

customs-analysis-area

Query trade area distribution analysis — retrieve trade distribution data by country/region for a specified HS code. Trigger: area distribution, trade by cou...

personAuthor: upkuajinghubclawhub
open_in_newRepositorydownloadDownload package

Customs Analysis Area

Query trade area distribution data from customs data using the UpKuaJing Open Platform API.

Overview

This skill provides trade area distribution data for a specified HS code, broken down by country/region. Given an HS code, country type (exporter/importer), and recent months, it returns trade counts, amounts, buyer/seller counts for each country.

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_analysis_area.py. Do NOT use shell compound commands like cd scripts && python customs_analysis_area.py

Area Distribution Query (customs_analysis_area.py)

  • Return granularity: One record per country/region
  • Use cases: Analyze which countries trade a specific product, understand geographic trade distribution, compare exporter vs importer countries
  • Examples:
    • "Show area distribution for HS code 04021000 in exporting countries"
    • "Which countries import product 04021000 the most?"
  • Parameters: See Area 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:

  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

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 area distribution data:

  • 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 | |-------------|---------| | "Show area distribution for HS code 04021000 in exporting countries" | Area Distribution Query | | "Which countries import product 04021000 the most?" | Area Distribution Query | | "Analyze geographic trade distribution for a product" | Area Distribution Query |

Usage Examples

Query Area Distribution

User request: "Show area distribution for HS code 04021000 in exporting countries over 12 months"

python scripts/customs_analysis_area.py --params '{"hscode":"04021000","countryType":1,"recentMonths":12}'

Query importing countries for a specific country:

python scripts/customs_analysis_area.py --params '{"hscode":"04021000","countryCode":"CN","countryType":2,"recentMonths":12}'

Query the next page:

python scripts/customs_analysis_area.py --params '{"hscode":"04021000","countryType":1,"recentMonths":12,"cursor":"eyJpZCI6MX0="}'

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

Best Practices

  1. Check API documentation:

    • Before executing queries, must first check the corresponding API reference documentation
    • Check references/customs-analysis-area-api.md
    • Do not guess parameter names, get accurate parameter names and formats from documentation

  2. Country type:

    • countryType=1 means exporting countries (suppliers)
    • countryType=2 means importing countries (buyers)

  3. Cross-skill usage:

    • First use customs-analysis-hscode-search and customs-analysis-hscode-detail to find and understand HS codes
    • Use customs-analysis-trends for monthly trends, then this skill for geographic breakdown
    • Combine with customs-analysis-trade-percent to see which companies dominate trade in each country

Notes

  • hscode, countryType, and recentMonths are required parameters
  • countryCode is optional — omit for global distribution
  • percentTrade is the trade percentage for the country relative to 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_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-analysis-trade-percent — Query trade percentage by company
  • 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-overview-summary — Query trade overview summary (aggregated)
  • customs-company-area-stats — Query company trade area statistics (aggregated)
  • customs-company-stats — Query company basic trade statistics
  • customs-company-product-list — Query company product list
  • customs-company-hscode-list — Query company HS code list
  • upkuajing-customs-trade-company-search — Search customs trade companies