@oomol-lab/open-connector 1.6.2 → 1.6.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -0
- package/assets/open-connector/catalog/apps/assured_platform.json +218 -0
- package/assets/open-connector/catalog/apps/baixiao.json +1080 -0
- package/assets/open-connector/catalog/apps/benchmarkone.json +956 -0
- package/assets/open-connector/catalog/apps/bing_webmaster.json +3097 -0
- package/assets/open-connector/catalog/apps/buzzsprout.json +1979 -0
- package/assets/open-connector/catalog/apps/feishu.json +13 -19
- package/assets/open-connector/catalog/apps/feishu_app_bot.json +10 -17
- package/assets/open-connector/catalog/apps/linkfox.json +836 -0
- package/assets/open-connector/catalog/apps/metatraderapi.json +1077 -0
- package/assets/open-connector/catalog/apps/mktindex.json +2411 -0
- package/assets/open-connector/catalog/apps/mojo_helpdesk.json +660 -0
- package/assets/open-connector/catalog/apps/mumble.json +446 -0
- package/assets/open-connector/catalog/apps/notion.json +112 -3
- package/assets/open-connector/catalog/apps/omise.json +438 -0
- package/assets/open-connector/catalog/apps/panjiva.json +2858 -0
- package/assets/open-connector/catalog/apps/papertrail.json +449 -0
- package/assets/open-connector/catalog/apps/peec.json +747 -0
- package/assets/open-connector/catalog/apps/polygon_io.json +5156 -584
- package/assets/open-connector/catalog/apps/quant_data.json +1928 -0
- package/assets/open-connector/catalog/apps/riddle_quiz_maker.json +621 -0
- package/assets/open-connector/catalog/apps/slack.json +327 -4
- package/assets/open-connector/catalog/apps/slackbot.json +280 -3
- package/assets/open-connector/catalog/apps/templatedocs.json +438 -0
- package/assets/open-connector/catalog/apps/terminus_app.json +510 -0
- package/assets/open-connector/catalog/apps/ticket_tailor.json +584 -0
- package/assets/open-connector/catalog/apps/tongdaxin.json +2612 -79
- package/assets/open-connector/catalog/apps/veremark.json +514 -0
- package/assets/open-connector/catalog/apps/walletap.json +549 -0
- package/assets/open-connector/catalog/apps/xiaohongshu_store.json +955 -39
- package/assets/open-connector/catalog/apps-index.json +1 -1
- package/package.json +5 -1
- package/src/connection-service.d.ts +2 -0
- package/src/connection-service.js +8 -1
- package/src/core/provider-id.d.ts +5 -0
- package/src/core/provider-id.js +12 -0
- package/src/oauth/oauth-credential-refresh-service.js +2 -0
- package/src/oauth/oauth-flow-service.js +2 -0
- package/src/providers/action-contracts.generated.d.ts +27 -7
- package/src/providers/assured_platform/executors.d.ts +4 -0
- package/src/providers/assured_platform/executors.js +18 -0
- package/src/providers/assured_platform/runtime.d.ts +7 -0
- package/src/providers/assured_platform/runtime.js +108 -0
- package/src/providers/baixiao/actions.d.ts +2 -0
- package/src/providers/baixiao/actions.js +377 -0
- package/src/providers/baixiao/executors.d.ts +4 -0
- package/src/providers/baixiao/executors.js +106 -0
- package/src/providers/benchmarkone/executors.d.ts +4 -0
- package/src/providers/benchmarkone/executors.js +26 -0
- package/src/providers/benchmarkone/runtime.d.ts +12 -0
- package/src/providers/benchmarkone/runtime.js +113 -0
- package/src/providers/bing_webmaster/actions.d.ts +2 -0
- package/src/providers/bing_webmaster/actions.js +113 -0
- package/src/providers/bing_webmaster/executors.d.ts +4 -0
- package/src/providers/bing_webmaster/executors.js +104 -0
- package/src/providers/bing_webmaster/management-actions.d.ts +2 -0
- package/src/providers/bing_webmaster/management-actions.js +241 -0
- package/src/providers/bing_webmaster/reporting-actions.d.ts +2 -0
- package/src/providers/bing_webmaster/reporting-actions.js +300 -0
- package/src/providers/bing_webmaster/schemas.d.ts +33 -0
- package/src/providers/bing_webmaster/schemas.js +313 -0
- package/src/providers/buzzsprout/executors.d.ts +4 -0
- package/src/providers/buzzsprout/executors.js +21 -0
- package/src/providers/buzzsprout/runtime.d.ts +12 -0
- package/src/providers/buzzsprout/runtime.js +237 -0
- package/src/providers/feishu/shared/drive-actions.d.ts +1 -0
- package/src/providers/feishu/shared/drive-actions.js +13 -9
- package/src/providers/feishu/shared/drive-runtime.js +15 -3
- package/src/providers/feishu/shared/wiki-actions.js +4 -2
- package/src/providers/hithink_finance/runtime.js +39 -60
- package/src/providers/linkfox/actions.js +2 -0
- package/src/providers/linkfox/runtime.js +70 -1
- package/src/providers/linkfox/sif-actions.d.ts +10 -0
- package/src/providers/linkfox/sif-actions.js +193 -0
- package/src/providers/metatraderapi/executors.d.ts +4 -0
- package/src/providers/metatraderapi/executors.js +18 -0
- package/src/providers/metatraderapi/runtime.d.ts +7 -0
- package/src/providers/metatraderapi/runtime.js +216 -0
- package/src/providers/mktindex/actions-mmi.d.ts +2 -0
- package/src/providers/mktindex/actions-mmi.js +510 -0
- package/src/providers/mktindex/actions.d.ts +2 -0
- package/src/providers/mktindex/actions.js +2 -0
- package/src/providers/mktindex/executors.d.ts +4 -0
- package/src/providers/mktindex/executors.js +27 -0
- package/src/providers/mktindex/request.d.ts +17 -0
- package/src/providers/mktindex/request.js +48 -0
- package/src/providers/mktindex/runtime.d.ts +9 -0
- package/src/providers/mktindex/runtime.js +492 -0
- package/src/providers/mojo_helpdesk/executors.d.ts +4 -0
- package/src/providers/mojo_helpdesk/executors.js +18 -0
- package/src/providers/mojo_helpdesk/runtime.d.ts +7 -0
- package/src/providers/mojo_helpdesk/runtime.js +173 -0
- package/src/providers/mumble/executors.d.ts +4 -0
- package/src/providers/mumble/executors.js +99 -0
- package/src/providers/notion/executors.d.ts +9 -0
- package/src/providers/notion/executors.js +161 -6
- package/src/providers/omise/executors.d.ts +4 -0
- package/src/providers/omise/executors.js +120 -0
- package/src/providers/panjiva/actions.d.ts +14 -0
- package/src/providers/panjiva/actions.js +389 -0
- package/src/providers/panjiva/executors.d.ts +4 -0
- package/src/providers/panjiva/executors.js +136 -0
- package/src/providers/papertrail/executors.d.ts +4 -0
- package/src/providers/papertrail/executors.js +15 -0
- package/src/providers/papertrail/runtime.d.ts +7 -0
- package/src/providers/papertrail/runtime.js +167 -0
- package/src/providers/peec/executors.d.ts +4 -0
- package/src/providers/peec/executors.js +15 -0
- package/src/providers/peec/runtime.d.ts +7 -0
- package/src/providers/peec/runtime.js +128 -0
- package/src/providers/polygon_io/actions.d.ts +2 -0
- package/src/providers/polygon_io/actions.js +282 -0
- package/src/providers/polygon_io/expanded-actions.d.ts +2 -0
- package/src/providers/polygon_io/expanded-actions.js +375 -0
- package/src/providers/polygon_io/expanded-runtime.d.ts +16 -0
- package/src/providers/polygon_io/expanded-runtime.js +277 -0
- package/src/providers/polygon_io/runtime.js +21 -2
- package/src/providers/quant_data/executors.d.ts +4 -0
- package/src/providers/quant_data/executors.js +15 -0
- package/src/providers/quant_data/runtime.d.ts +7 -0
- package/src/providers/quant_data/runtime.js +118 -0
- package/src/providers/registry.generated.js +20 -0
- package/src/providers/riddle_quiz_maker/executors.d.ts +4 -0
- package/src/providers/riddle_quiz_maker/executors.js +15 -0
- package/src/providers/riddle_quiz_maker/runtime.d.ts +7 -0
- package/src/providers/riddle_quiz_maker/runtime.js +145 -0
- package/src/providers/slack/actions.js +106 -3
- package/src/providers/slack/runtime.js +260 -36
- package/src/providers/slackbot/actions.js +1 -1
- package/src/providers/templatedocs/executors.d.ts +4 -0
- package/src/providers/templatedocs/executors.js +18 -0
- package/src/providers/templatedocs/runtime.d.ts +13 -0
- package/src/providers/templatedocs/runtime.js +151 -0
- package/src/providers/terminus_app/executors.d.ts +4 -0
- package/src/providers/terminus_app/executors.js +15 -0
- package/src/providers/terminus_app/runtime.d.ts +7 -0
- package/src/providers/terminus_app/runtime.js +172 -0
- package/src/providers/ticket_tailor/executors.d.ts +4 -0
- package/src/providers/ticket_tailor/executors.js +15 -0
- package/src/providers/ticket_tailor/runtime.d.ts +7 -0
- package/src/providers/ticket_tailor/runtime.js +152 -0
- package/src/providers/tongdaxin/actions.d.ts +1 -0
- package/src/providers/tongdaxin/actions.js +6 -3
- package/src/providers/tongdaxin/executors.js +51 -10
- package/src/providers/tongdaxin/named-action-output.d.ts +1 -0
- package/src/providers/tongdaxin/named-action-output.js +149 -0
- package/src/providers/tongdaxin/named-action-routing.d.ts +9 -0
- package/src/providers/tongdaxin/named-action-routing.js +417 -0
- package/src/providers/tongdaxin/named-actions.d.ts +2 -0
- package/src/providers/tongdaxin/named-actions.js +378 -0
- package/src/providers/veremark/executors.d.ts +4 -0
- package/src/providers/veremark/executors.js +129 -0
- package/src/providers/walletap/executors.d.ts +4 -0
- package/src/providers/walletap/executors.js +15 -0
- package/src/providers/walletap/runtime.d.ts +7 -0
- package/src/providers/walletap/runtime.js +147 -0
- package/src/providers/weixin_official_account/access-token.js +31 -7
- package/src/providers/weixin_store/access-token.js +33 -7
- package/src/providers/xiaohongshu_store/executors.js +152 -3
- package/src/server/api/openapi.js +3 -0
- package/src/server/connector-assets.d.ts +4 -0
- package/src/server/connector-assets.js +12 -0
- package/src/server/connector-build.d.ts +33 -0
- package/src/server/connector-build.js +73 -0
- package/src/server/connector-runtime.d.ts +1 -2
- package/src/server/connector-runtime.js +2 -8
- package/src/server/server-assets.d.ts +0 -28
- package/src/server/server-assets.js +0 -50
|
@@ -0,0 +1,2858 @@
|
|
|
1
|
+
{
|
|
2
|
+
"service": "panjiva",
|
|
3
|
+
"displayName": "Panjiva",
|
|
4
|
+
"description": "Query Panjiva trade, company, shipment, and analytics data.",
|
|
5
|
+
"categories": [
|
|
6
|
+
"Data & Analytics",
|
|
7
|
+
"Cross-border E-commerce"
|
|
8
|
+
],
|
|
9
|
+
"authTypes": [
|
|
10
|
+
"custom_credential"
|
|
11
|
+
],
|
|
12
|
+
"auth": [
|
|
13
|
+
{
|
|
14
|
+
"type": "custom_credential",
|
|
15
|
+
"fields": [
|
|
16
|
+
{
|
|
17
|
+
"key": "clientId",
|
|
18
|
+
"label": "Client ID",
|
|
19
|
+
"required": true,
|
|
20
|
+
"secret": false,
|
|
21
|
+
"inputType": "text",
|
|
22
|
+
"description": "Copy the client ID from myPanjiva > API Settings. See https://panjiva.com/api-guide/authentication."
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
"key": "clientSecret",
|
|
26
|
+
"label": "Client Secret",
|
|
27
|
+
"required": true,
|
|
28
|
+
"secret": true,
|
|
29
|
+
"inputType": "password",
|
|
30
|
+
"description": "Copy the client secret paired with the client ID from myPanjiva > API Settings. See https://panjiva.com/api-guide/authentication."
|
|
31
|
+
}
|
|
32
|
+
]
|
|
33
|
+
}
|
|
34
|
+
],
|
|
35
|
+
"homepageUrl": "https://panjiva.com/",
|
|
36
|
+
"actions": [
|
|
37
|
+
{
|
|
38
|
+
"id": "panjiva.batch_search_companies",
|
|
39
|
+
"service": "panjiva",
|
|
40
|
+
"name": "batch_search_companies",
|
|
41
|
+
"description": "Submit multiple company searches as one downloadable batch. Poll get_batch_job_status with the returned job ID.",
|
|
42
|
+
"operationType": "write",
|
|
43
|
+
"requiredScopes": [],
|
|
44
|
+
"providerPermissions": [],
|
|
45
|
+
"inputSchema": {
|
|
46
|
+
"type": "object",
|
|
47
|
+
"properties": {
|
|
48
|
+
"output_format": {
|
|
49
|
+
"type": "string",
|
|
50
|
+
"enum": [
|
|
51
|
+
"jsonl",
|
|
52
|
+
"csv"
|
|
53
|
+
],
|
|
54
|
+
"description": "Download file format; upstream default is jsonl."
|
|
55
|
+
},
|
|
56
|
+
"notify_email": {
|
|
57
|
+
"type": "string",
|
|
58
|
+
"description": "Optional email address for job completion notification. Omit to retrieve the download URL by polling.",
|
|
59
|
+
"format": "email"
|
|
60
|
+
},
|
|
61
|
+
"requests": {
|
|
62
|
+
"type": "array",
|
|
63
|
+
"items": {
|
|
64
|
+
"type": "object",
|
|
65
|
+
"properties": {
|
|
66
|
+
"query": {
|
|
67
|
+
"type": "object",
|
|
68
|
+
"properties": {
|
|
69
|
+
"text": {
|
|
70
|
+
"type": "string",
|
|
71
|
+
"description": "Search text. Supports + (AND), | (OR), - (exclude), quoted phrases, trailing *, and parentheses."
|
|
72
|
+
},
|
|
73
|
+
"group": {
|
|
74
|
+
"type": "string",
|
|
75
|
+
"description": "Named search group, such as goods_described, consignee_name, shipper_name, or main. Discover groups with get_data_source_metadata."
|
|
76
|
+
},
|
|
77
|
+
"custom_group": {
|
|
78
|
+
"type": "array",
|
|
79
|
+
"items": {
|
|
80
|
+
"type": "string",
|
|
81
|
+
"description": "Searchable field name."
|
|
82
|
+
},
|
|
83
|
+
"description": "Explicit fields to search instead of a named group."
|
|
84
|
+
},
|
|
85
|
+
"operator": {
|
|
86
|
+
"type": "string",
|
|
87
|
+
"enum": [
|
|
88
|
+
"AND",
|
|
89
|
+
"OR"
|
|
90
|
+
],
|
|
91
|
+
"description": "Boolean operator between search terms; the upstream default is OR."
|
|
92
|
+
},
|
|
93
|
+
"match": {
|
|
94
|
+
"type": "string",
|
|
95
|
+
"enum": [
|
|
96
|
+
"stem",
|
|
97
|
+
"exact"
|
|
98
|
+
],
|
|
99
|
+
"description": "Match word stems or exact terms; the upstream default is stem."
|
|
100
|
+
}
|
|
101
|
+
},
|
|
102
|
+
"additionalProperties": false,
|
|
103
|
+
"required": [
|
|
104
|
+
"text"
|
|
105
|
+
],
|
|
106
|
+
"description": "Free-text search criteria."
|
|
107
|
+
},
|
|
108
|
+
"queries": {
|
|
109
|
+
"type": "array",
|
|
110
|
+
"items": {
|
|
111
|
+
"type": "object",
|
|
112
|
+
"properties": {
|
|
113
|
+
"text": {
|
|
114
|
+
"type": "string",
|
|
115
|
+
"description": "Search text. Supports + (AND), | (OR), - (exclude), quoted phrases, trailing *, and parentheses."
|
|
116
|
+
},
|
|
117
|
+
"group": {
|
|
118
|
+
"type": "string",
|
|
119
|
+
"description": "Named search group, such as goods_described, consignee_name, shipper_name, or main. Discover groups with get_data_source_metadata."
|
|
120
|
+
},
|
|
121
|
+
"custom_group": {
|
|
122
|
+
"type": "array",
|
|
123
|
+
"items": {
|
|
124
|
+
"type": "string",
|
|
125
|
+
"description": "Searchable field name."
|
|
126
|
+
},
|
|
127
|
+
"description": "Explicit fields to search instead of a named group."
|
|
128
|
+
},
|
|
129
|
+
"operator": {
|
|
130
|
+
"type": "string",
|
|
131
|
+
"enum": [
|
|
132
|
+
"AND",
|
|
133
|
+
"OR"
|
|
134
|
+
],
|
|
135
|
+
"description": "Boolean operator between search terms; the upstream default is OR."
|
|
136
|
+
},
|
|
137
|
+
"match": {
|
|
138
|
+
"type": "string",
|
|
139
|
+
"enum": [
|
|
140
|
+
"stem",
|
|
141
|
+
"exact"
|
|
142
|
+
],
|
|
143
|
+
"description": "Match word stems or exact terms; the upstream default is stem."
|
|
144
|
+
}
|
|
145
|
+
},
|
|
146
|
+
"additionalProperties": false,
|
|
147
|
+
"required": [
|
|
148
|
+
"text"
|
|
149
|
+
],
|
|
150
|
+
"description": "Free-text search criteria."
|
|
151
|
+
},
|
|
152
|
+
"description": "Multiple search criteria; every query must match.",
|
|
153
|
+
"maxItems": 500
|
|
154
|
+
},
|
|
155
|
+
"filters": {
|
|
156
|
+
"type": "object",
|
|
157
|
+
"properties": {},
|
|
158
|
+
"additionalProperties": true,
|
|
159
|
+
"description": "Native Panjiva filters, including AND, OR, NOT, ranges, dates and geographic constraints. For example: {record_date:{gte:'2025-01-01'},destination_countries:'United States'}. Discover fields with get_data_source_metadata; syntax: https://panjiva.com/api-guide/data-selection/filters."
|
|
160
|
+
},
|
|
161
|
+
"company_type": {
|
|
162
|
+
"type": "string",
|
|
163
|
+
"enum": [
|
|
164
|
+
"ccn",
|
|
165
|
+
"country_company_name",
|
|
166
|
+
"pid",
|
|
167
|
+
"capiq",
|
|
168
|
+
"ultimate_parent_capiq"
|
|
169
|
+
],
|
|
170
|
+
"description": "Company identifier representation; upstream default is country_company_name."
|
|
171
|
+
},
|
|
172
|
+
"direction": {
|
|
173
|
+
"type": "string",
|
|
174
|
+
"enum": [
|
|
175
|
+
"bidirectional",
|
|
176
|
+
"consignee",
|
|
177
|
+
"shipper"
|
|
178
|
+
],
|
|
179
|
+
"description": "Trade role to search; upstream default is bidirectional."
|
|
180
|
+
},
|
|
181
|
+
"metrics": {
|
|
182
|
+
"type": "array",
|
|
183
|
+
"items": {
|
|
184
|
+
"type": "object",
|
|
185
|
+
"properties": {
|
|
186
|
+
"metric": {
|
|
187
|
+
"type": "string",
|
|
188
|
+
"description": "Numeric field to aggregate, such as value_usd, weight_kg or volume_teu. Available fields depend on the data source."
|
|
189
|
+
},
|
|
190
|
+
"op": {
|
|
191
|
+
"type": "string",
|
|
192
|
+
"enum": [
|
|
193
|
+
"sum",
|
|
194
|
+
"max",
|
|
195
|
+
"avg",
|
|
196
|
+
"min"
|
|
197
|
+
],
|
|
198
|
+
"description": "Statistical aggregation operation."
|
|
199
|
+
}
|
|
200
|
+
},
|
|
201
|
+
"additionalProperties": false,
|
|
202
|
+
"description": "Metric and aggregation operation."
|
|
203
|
+
},
|
|
204
|
+
"description": "Aggregate statistics across matching shipments."
|
|
205
|
+
},
|
|
206
|
+
"size": {
|
|
207
|
+
"type": "integer",
|
|
208
|
+
"minimum": 0,
|
|
209
|
+
"maximum": 5000,
|
|
210
|
+
"description": "Maximum company results per trade direction."
|
|
211
|
+
},
|
|
212
|
+
"sort": {
|
|
213
|
+
"type": "object",
|
|
214
|
+
"properties": {
|
|
215
|
+
"key": {
|
|
216
|
+
"type": "string",
|
|
217
|
+
"description": "Sort by count, field, or an available metric."
|
|
218
|
+
},
|
|
219
|
+
"order": {
|
|
220
|
+
"type": "string",
|
|
221
|
+
"enum": [
|
|
222
|
+
"asc",
|
|
223
|
+
"desc"
|
|
224
|
+
],
|
|
225
|
+
"description": "Ascending or descending order."
|
|
226
|
+
},
|
|
227
|
+
"op": {
|
|
228
|
+
"type": "string",
|
|
229
|
+
"enum": [
|
|
230
|
+
"sum",
|
|
231
|
+
"max",
|
|
232
|
+
"avg",
|
|
233
|
+
"min"
|
|
234
|
+
],
|
|
235
|
+
"description": "Statistical aggregation operation."
|
|
236
|
+
}
|
|
237
|
+
},
|
|
238
|
+
"additionalProperties": false,
|
|
239
|
+
"required": [
|
|
240
|
+
"key"
|
|
241
|
+
],
|
|
242
|
+
"description": "Sort an aggregation; metric keys must also be declared in metrics."
|
|
243
|
+
}
|
|
244
|
+
},
|
|
245
|
+
"additionalProperties": false,
|
|
246
|
+
"description": "Company search criteria."
|
|
247
|
+
},
|
|
248
|
+
"description": "Individual company search requests.",
|
|
249
|
+
"minItems": 1,
|
|
250
|
+
"maxItems": 50000
|
|
251
|
+
}
|
|
252
|
+
},
|
|
253
|
+
"additionalProperties": false,
|
|
254
|
+
"required": [
|
|
255
|
+
"requests"
|
|
256
|
+
],
|
|
257
|
+
"description": "Batch company searches."
|
|
258
|
+
},
|
|
259
|
+
"outputSchema": {
|
|
260
|
+
"type": "object",
|
|
261
|
+
"properties": {
|
|
262
|
+
"job_id": {
|
|
263
|
+
"type": "string",
|
|
264
|
+
"description": "Job ID returned by the corresponding submission action.",
|
|
265
|
+
"format": "uuid"
|
|
266
|
+
},
|
|
267
|
+
"status": {
|
|
268
|
+
"type": "string",
|
|
269
|
+
"description": "Upstream job status, initially submitted."
|
|
270
|
+
}
|
|
271
|
+
},
|
|
272
|
+
"additionalProperties": true,
|
|
273
|
+
"description": "Submitted asynchronous job."
|
|
274
|
+
},
|
|
275
|
+
"asyncLifecycle": {
|
|
276
|
+
"startActionId": "panjiva.batch_search_companies",
|
|
277
|
+
"statusActionId": "panjiva.get_batch_job_status"
|
|
278
|
+
}
|
|
279
|
+
},
|
|
280
|
+
{
|
|
281
|
+
"id": "panjiva.bulk_rollup_shipments",
|
|
282
|
+
"service": "panjiva",
|
|
283
|
+
"name": "bulk_rollup_shipments",
|
|
284
|
+
"description": "Submit a bulk shipment aggregation for JSONL or CSV download. Poll get_bulk_job_status with the returned job ID.",
|
|
285
|
+
"operationType": "write",
|
|
286
|
+
"requiredScopes": [],
|
|
287
|
+
"providerPermissions": [],
|
|
288
|
+
"inputSchema": {
|
|
289
|
+
"type": "object",
|
|
290
|
+
"properties": {
|
|
291
|
+
"output_format": {
|
|
292
|
+
"type": "string",
|
|
293
|
+
"enum": [
|
|
294
|
+
"jsonl",
|
|
295
|
+
"csv"
|
|
296
|
+
],
|
|
297
|
+
"description": "Download file format; upstream default is jsonl."
|
|
298
|
+
},
|
|
299
|
+
"notify_email": {
|
|
300
|
+
"type": "string",
|
|
301
|
+
"description": "Optional email address for job completion notification. Omit to retrieve the download URL by polling.",
|
|
302
|
+
"format": "email"
|
|
303
|
+
},
|
|
304
|
+
"data_source": {
|
|
305
|
+
"type": "string",
|
|
306
|
+
"minLength": 1,
|
|
307
|
+
"description": "Data source, such as global or us-imports. Use list_data_sources to discover available sources; global covers the last five years."
|
|
308
|
+
},
|
|
309
|
+
"query": {
|
|
310
|
+
"type": "object",
|
|
311
|
+
"properties": {
|
|
312
|
+
"text": {
|
|
313
|
+
"type": "string",
|
|
314
|
+
"description": "Search text. Supports + (AND), | (OR), - (exclude), quoted phrases, trailing *, and parentheses."
|
|
315
|
+
},
|
|
316
|
+
"group": {
|
|
317
|
+
"type": "string",
|
|
318
|
+
"description": "Named search group, such as goods_described, consignee_name, shipper_name, or main. Discover groups with get_data_source_metadata."
|
|
319
|
+
},
|
|
320
|
+
"custom_group": {
|
|
321
|
+
"type": "array",
|
|
322
|
+
"items": {
|
|
323
|
+
"type": "string",
|
|
324
|
+
"description": "Searchable field name."
|
|
325
|
+
},
|
|
326
|
+
"description": "Explicit fields to search instead of a named group."
|
|
327
|
+
},
|
|
328
|
+
"operator": {
|
|
329
|
+
"type": "string",
|
|
330
|
+
"enum": [
|
|
331
|
+
"AND",
|
|
332
|
+
"OR"
|
|
333
|
+
],
|
|
334
|
+
"description": "Boolean operator between search terms; the upstream default is OR."
|
|
335
|
+
},
|
|
336
|
+
"match": {
|
|
337
|
+
"type": "string",
|
|
338
|
+
"enum": [
|
|
339
|
+
"stem",
|
|
340
|
+
"exact"
|
|
341
|
+
],
|
|
342
|
+
"description": "Match word stems or exact terms; the upstream default is stem."
|
|
343
|
+
}
|
|
344
|
+
},
|
|
345
|
+
"additionalProperties": false,
|
|
346
|
+
"required": [
|
|
347
|
+
"text"
|
|
348
|
+
],
|
|
349
|
+
"description": "Free-text search criteria."
|
|
350
|
+
},
|
|
351
|
+
"queries": {
|
|
352
|
+
"type": "array",
|
|
353
|
+
"items": {
|
|
354
|
+
"type": "object",
|
|
355
|
+
"properties": {
|
|
356
|
+
"text": {
|
|
357
|
+
"type": "string",
|
|
358
|
+
"description": "Search text. Supports + (AND), | (OR), - (exclude), quoted phrases, trailing *, and parentheses."
|
|
359
|
+
},
|
|
360
|
+
"group": {
|
|
361
|
+
"type": "string",
|
|
362
|
+
"description": "Named search group, such as goods_described, consignee_name, shipper_name, or main. Discover groups with get_data_source_metadata."
|
|
363
|
+
},
|
|
364
|
+
"custom_group": {
|
|
365
|
+
"type": "array",
|
|
366
|
+
"items": {
|
|
367
|
+
"type": "string",
|
|
368
|
+
"description": "Searchable field name."
|
|
369
|
+
},
|
|
370
|
+
"description": "Explicit fields to search instead of a named group."
|
|
371
|
+
},
|
|
372
|
+
"operator": {
|
|
373
|
+
"type": "string",
|
|
374
|
+
"enum": [
|
|
375
|
+
"AND",
|
|
376
|
+
"OR"
|
|
377
|
+
],
|
|
378
|
+
"description": "Boolean operator between search terms; the upstream default is OR."
|
|
379
|
+
},
|
|
380
|
+
"match": {
|
|
381
|
+
"type": "string",
|
|
382
|
+
"enum": [
|
|
383
|
+
"stem",
|
|
384
|
+
"exact"
|
|
385
|
+
],
|
|
386
|
+
"description": "Match word stems or exact terms; the upstream default is stem."
|
|
387
|
+
}
|
|
388
|
+
},
|
|
389
|
+
"additionalProperties": false,
|
|
390
|
+
"required": [
|
|
391
|
+
"text"
|
|
392
|
+
],
|
|
393
|
+
"description": "Free-text search criteria."
|
|
394
|
+
},
|
|
395
|
+
"description": "Multiple search criteria; every query must match.",
|
|
396
|
+
"maxItems": 500
|
|
397
|
+
},
|
|
398
|
+
"filters": {
|
|
399
|
+
"type": "object",
|
|
400
|
+
"properties": {},
|
|
401
|
+
"additionalProperties": true,
|
|
402
|
+
"description": "Native Panjiva filters, including AND, OR, NOT, ranges, dates and geographic constraints. For example: {record_date:{gte:'2025-01-01'},destination_countries:'United States'}. Discover fields with get_data_source_metadata; syntax: https://panjiva.com/api-guide/data-selection/filters."
|
|
403
|
+
},
|
|
404
|
+
"metrics": {
|
|
405
|
+
"type": "array",
|
|
406
|
+
"items": {
|
|
407
|
+
"type": "object",
|
|
408
|
+
"properties": {
|
|
409
|
+
"metric": {
|
|
410
|
+
"type": "string",
|
|
411
|
+
"description": "Numeric field to aggregate, such as value_usd, weight_kg or volume_teu. Available fields depend on the data source."
|
|
412
|
+
},
|
|
413
|
+
"op": {
|
|
414
|
+
"type": "string",
|
|
415
|
+
"enum": [
|
|
416
|
+
"sum",
|
|
417
|
+
"max",
|
|
418
|
+
"avg",
|
|
419
|
+
"min"
|
|
420
|
+
],
|
|
421
|
+
"description": "Statistical aggregation operation."
|
|
422
|
+
}
|
|
423
|
+
},
|
|
424
|
+
"additionalProperties": false,
|
|
425
|
+
"description": "Metric and aggregation operation."
|
|
426
|
+
},
|
|
427
|
+
"description": "Aggregate statistics across matching shipments."
|
|
428
|
+
},
|
|
429
|
+
"dimensions": {
|
|
430
|
+
"type": "array",
|
|
431
|
+
"items": {
|
|
432
|
+
"type": "object",
|
|
433
|
+
"properties": {
|
|
434
|
+
"field": {
|
|
435
|
+
"type": "string",
|
|
436
|
+
"description": "Field to group by; discover available dimensions with get_data_source_metadata."
|
|
437
|
+
},
|
|
438
|
+
"include_missing": {
|
|
439
|
+
"type": "boolean",
|
|
440
|
+
"description": "Include missing values as NO_VALUE buckets."
|
|
441
|
+
},
|
|
442
|
+
"sort": {
|
|
443
|
+
"type": "object",
|
|
444
|
+
"properties": {
|
|
445
|
+
"key": {
|
|
446
|
+
"type": "string",
|
|
447
|
+
"description": "Sort by count, field, or an available metric."
|
|
448
|
+
},
|
|
449
|
+
"order": {
|
|
450
|
+
"type": "string",
|
|
451
|
+
"enum": [
|
|
452
|
+
"asc",
|
|
453
|
+
"desc"
|
|
454
|
+
],
|
|
455
|
+
"description": "Ascending or descending order."
|
|
456
|
+
},
|
|
457
|
+
"op": {
|
|
458
|
+
"type": "string",
|
|
459
|
+
"enum": [
|
|
460
|
+
"sum",
|
|
461
|
+
"max",
|
|
462
|
+
"avg",
|
|
463
|
+
"min"
|
|
464
|
+
],
|
|
465
|
+
"description": "Statistical aggregation operation."
|
|
466
|
+
}
|
|
467
|
+
},
|
|
468
|
+
"additionalProperties": false,
|
|
469
|
+
"required": [
|
|
470
|
+
"key"
|
|
471
|
+
],
|
|
472
|
+
"description": "Sort an aggregation; metric keys must also be declared in metrics."
|
|
473
|
+
}
|
|
474
|
+
},
|
|
475
|
+
"additionalProperties": false,
|
|
476
|
+
"required": [
|
|
477
|
+
"field",
|
|
478
|
+
"sort"
|
|
479
|
+
],
|
|
480
|
+
"description": "One bulk grouping dimension."
|
|
481
|
+
},
|
|
482
|
+
"description": "One grouping dimension for a bulk rollup without synchronous pagination limits.",
|
|
483
|
+
"minItems": 1,
|
|
484
|
+
"maxItems": 1
|
|
485
|
+
}
|
|
486
|
+
},
|
|
487
|
+
"additionalProperties": false,
|
|
488
|
+
"required": [
|
|
489
|
+
"data_source",
|
|
490
|
+
"dimensions"
|
|
491
|
+
],
|
|
492
|
+
"description": "Bulk shipment rollup criteria."
|
|
493
|
+
},
|
|
494
|
+
"outputSchema": {
|
|
495
|
+
"type": "object",
|
|
496
|
+
"properties": {
|
|
497
|
+
"job_id": {
|
|
498
|
+
"type": "string",
|
|
499
|
+
"description": "Job ID returned by the corresponding submission action.",
|
|
500
|
+
"format": "uuid"
|
|
501
|
+
},
|
|
502
|
+
"status": {
|
|
503
|
+
"type": "string",
|
|
504
|
+
"description": "Upstream job status, initially submitted."
|
|
505
|
+
}
|
|
506
|
+
},
|
|
507
|
+
"additionalProperties": true,
|
|
508
|
+
"description": "Submitted asynchronous job."
|
|
509
|
+
},
|
|
510
|
+
"asyncLifecycle": {
|
|
511
|
+
"startActionId": "panjiva.bulk_rollup_shipments",
|
|
512
|
+
"statusActionId": "panjiva.get_bulk_job_status"
|
|
513
|
+
}
|
|
514
|
+
},
|
|
515
|
+
{
|
|
516
|
+
"id": "panjiva.bulk_search_shipments",
|
|
517
|
+
"service": "panjiva",
|
|
518
|
+
"name": "bulk_search_shipments",
|
|
519
|
+
"description": "Submit a large shipment search for JSONL or CSV download. Poll get_bulk_job_status with the returned job ID.",
|
|
520
|
+
"operationType": "write",
|
|
521
|
+
"requiredScopes": [],
|
|
522
|
+
"providerPermissions": [],
|
|
523
|
+
"inputSchema": {
|
|
524
|
+
"type": "object",
|
|
525
|
+
"properties": {
|
|
526
|
+
"output_format": {
|
|
527
|
+
"type": "string",
|
|
528
|
+
"enum": [
|
|
529
|
+
"jsonl",
|
|
530
|
+
"csv"
|
|
531
|
+
],
|
|
532
|
+
"description": "Download file format; upstream default is jsonl."
|
|
533
|
+
},
|
|
534
|
+
"notify_email": {
|
|
535
|
+
"type": "string",
|
|
536
|
+
"description": "Optional email address for job completion notification. Omit to retrieve the download URL by polling.",
|
|
537
|
+
"format": "email"
|
|
538
|
+
},
|
|
539
|
+
"data_source": {
|
|
540
|
+
"type": "string",
|
|
541
|
+
"minLength": 1,
|
|
542
|
+
"description": "Data source, such as global or us-imports. Use list_data_sources to discover available sources; global covers the last five years."
|
|
543
|
+
},
|
|
544
|
+
"query": {
|
|
545
|
+
"type": "object",
|
|
546
|
+
"properties": {
|
|
547
|
+
"text": {
|
|
548
|
+
"type": "string",
|
|
549
|
+
"description": "Search text. Supports + (AND), | (OR), - (exclude), quoted phrases, trailing *, and parentheses."
|
|
550
|
+
},
|
|
551
|
+
"group": {
|
|
552
|
+
"type": "string",
|
|
553
|
+
"description": "Named search group, such as goods_described, consignee_name, shipper_name, or main. Discover groups with get_data_source_metadata."
|
|
554
|
+
},
|
|
555
|
+
"custom_group": {
|
|
556
|
+
"type": "array",
|
|
557
|
+
"items": {
|
|
558
|
+
"type": "string",
|
|
559
|
+
"description": "Searchable field name."
|
|
560
|
+
},
|
|
561
|
+
"description": "Explicit fields to search instead of a named group."
|
|
562
|
+
},
|
|
563
|
+
"operator": {
|
|
564
|
+
"type": "string",
|
|
565
|
+
"enum": [
|
|
566
|
+
"AND",
|
|
567
|
+
"OR"
|
|
568
|
+
],
|
|
569
|
+
"description": "Boolean operator between search terms; the upstream default is OR."
|
|
570
|
+
},
|
|
571
|
+
"match": {
|
|
572
|
+
"type": "string",
|
|
573
|
+
"enum": [
|
|
574
|
+
"stem",
|
|
575
|
+
"exact"
|
|
576
|
+
],
|
|
577
|
+
"description": "Match word stems or exact terms; the upstream default is stem."
|
|
578
|
+
}
|
|
579
|
+
},
|
|
580
|
+
"additionalProperties": false,
|
|
581
|
+
"required": [
|
|
582
|
+
"text"
|
|
583
|
+
],
|
|
584
|
+
"description": "Free-text search criteria."
|
|
585
|
+
},
|
|
586
|
+
"queries": {
|
|
587
|
+
"type": "array",
|
|
588
|
+
"items": {
|
|
589
|
+
"type": "object",
|
|
590
|
+
"properties": {
|
|
591
|
+
"text": {
|
|
592
|
+
"type": "string",
|
|
593
|
+
"description": "Search text. Supports + (AND), | (OR), - (exclude), quoted phrases, trailing *, and parentheses."
|
|
594
|
+
},
|
|
595
|
+
"group": {
|
|
596
|
+
"type": "string",
|
|
597
|
+
"description": "Named search group, such as goods_described, consignee_name, shipper_name, or main. Discover groups with get_data_source_metadata."
|
|
598
|
+
},
|
|
599
|
+
"custom_group": {
|
|
600
|
+
"type": "array",
|
|
601
|
+
"items": {
|
|
602
|
+
"type": "string",
|
|
603
|
+
"description": "Searchable field name."
|
|
604
|
+
},
|
|
605
|
+
"description": "Explicit fields to search instead of a named group."
|
|
606
|
+
},
|
|
607
|
+
"operator": {
|
|
608
|
+
"type": "string",
|
|
609
|
+
"enum": [
|
|
610
|
+
"AND",
|
|
611
|
+
"OR"
|
|
612
|
+
],
|
|
613
|
+
"description": "Boolean operator between search terms; the upstream default is OR."
|
|
614
|
+
},
|
|
615
|
+
"match": {
|
|
616
|
+
"type": "string",
|
|
617
|
+
"enum": [
|
|
618
|
+
"stem",
|
|
619
|
+
"exact"
|
|
620
|
+
],
|
|
621
|
+
"description": "Match word stems or exact terms; the upstream default is stem."
|
|
622
|
+
}
|
|
623
|
+
},
|
|
624
|
+
"additionalProperties": false,
|
|
625
|
+
"required": [
|
|
626
|
+
"text"
|
|
627
|
+
],
|
|
628
|
+
"description": "Free-text search criteria."
|
|
629
|
+
},
|
|
630
|
+
"description": "Multiple search criteria; every query must match.",
|
|
631
|
+
"maxItems": 500
|
|
632
|
+
},
|
|
633
|
+
"filters": {
|
|
634
|
+
"type": "object",
|
|
635
|
+
"properties": {},
|
|
636
|
+
"additionalProperties": true,
|
|
637
|
+
"description": "Native Panjiva filters, including AND, OR, NOT, ranges, dates and geographic constraints. For example: {record_date:{gte:'2025-01-01'},destination_countries:'United States'}. Discover fields with get_data_source_metadata; syntax: https://panjiva.com/api-guide/data-selection/filters."
|
|
638
|
+
},
|
|
639
|
+
"sort": {
|
|
640
|
+
"type": "array",
|
|
641
|
+
"items": {
|
|
642
|
+
"type": "object",
|
|
643
|
+
"properties": {
|
|
644
|
+
"field": {
|
|
645
|
+
"type": "string",
|
|
646
|
+
"description": "Sortable shipment field; discover fields with get_data_source_metadata."
|
|
647
|
+
},
|
|
648
|
+
"order": {
|
|
649
|
+
"type": "string",
|
|
650
|
+
"enum": [
|
|
651
|
+
"asc",
|
|
652
|
+
"desc"
|
|
653
|
+
],
|
|
654
|
+
"description": "Ascending or descending order."
|
|
655
|
+
}
|
|
656
|
+
},
|
|
657
|
+
"additionalProperties": false,
|
|
658
|
+
"description": "One shipment sort rule."
|
|
659
|
+
},
|
|
660
|
+
"description": "Shipment sort fields in priority order."
|
|
661
|
+
}
|
|
662
|
+
},
|
|
663
|
+
"additionalProperties": false,
|
|
664
|
+
"required": [
|
|
665
|
+
"data_source"
|
|
666
|
+
],
|
|
667
|
+
"description": "Bulk shipment search criteria."
|
|
668
|
+
},
|
|
669
|
+
"outputSchema": {
|
|
670
|
+
"type": "object",
|
|
671
|
+
"properties": {
|
|
672
|
+
"job_id": {
|
|
673
|
+
"type": "string",
|
|
674
|
+
"description": "Job ID returned by the corresponding submission action.",
|
|
675
|
+
"format": "uuid"
|
|
676
|
+
},
|
|
677
|
+
"status": {
|
|
678
|
+
"type": "string",
|
|
679
|
+
"description": "Upstream job status, initially submitted."
|
|
680
|
+
}
|
|
681
|
+
},
|
|
682
|
+
"additionalProperties": true,
|
|
683
|
+
"description": "Submitted asynchronous job."
|
|
684
|
+
},
|
|
685
|
+
"asyncLifecycle": {
|
|
686
|
+
"startActionId": "panjiva.bulk_search_shipments",
|
|
687
|
+
"statusActionId": "panjiva.get_bulk_job_status"
|
|
688
|
+
}
|
|
689
|
+
},
|
|
690
|
+
{
|
|
691
|
+
"id": "panjiva.get_batch_job_status",
|
|
692
|
+
"service": "panjiva",
|
|
693
|
+
"name": "get_batch_job_status",
|
|
694
|
+
"description": "Check a batch company search job and retrieve its download URL when ready.",
|
|
695
|
+
"operationType": "read",
|
|
696
|
+
"requiredScopes": [],
|
|
697
|
+
"providerPermissions": [],
|
|
698
|
+
"inputSchema": {
|
|
699
|
+
"type": "object",
|
|
700
|
+
"properties": {
|
|
701
|
+
"job_id": {
|
|
702
|
+
"type": "string",
|
|
703
|
+
"description": "Job ID returned by the corresponding submission action.",
|
|
704
|
+
"format": "uuid"
|
|
705
|
+
}
|
|
706
|
+
},
|
|
707
|
+
"additionalProperties": false,
|
|
708
|
+
"description": "Batch job to inspect."
|
|
709
|
+
},
|
|
710
|
+
"outputSchema": {
|
|
711
|
+
"type": "object",
|
|
712
|
+
"properties": {
|
|
713
|
+
"id": {
|
|
714
|
+
"type": "string",
|
|
715
|
+
"description": "Job ID returned by the corresponding submission action.",
|
|
716
|
+
"format": "uuid"
|
|
717
|
+
},
|
|
718
|
+
"status": {
|
|
719
|
+
"type": "string",
|
|
720
|
+
"description": "Upstream state: submitted, in_process, fetched, uploaded, notification_sent, or error."
|
|
721
|
+
},
|
|
722
|
+
"download_url": {
|
|
723
|
+
"type": "string",
|
|
724
|
+
"description": "Download URL when ready; pass this URL to a file consumer."
|
|
725
|
+
},
|
|
726
|
+
"last_changed": {
|
|
727
|
+
"type": "string",
|
|
728
|
+
"description": "Time of the latest state change.",
|
|
729
|
+
"format": "date-time"
|
|
730
|
+
},
|
|
731
|
+
"parameters": {
|
|
732
|
+
"type": "object",
|
|
733
|
+
"properties": {},
|
|
734
|
+
"additionalProperties": true,
|
|
735
|
+
"description": "Original job parameters."
|
|
736
|
+
}
|
|
737
|
+
},
|
|
738
|
+
"additionalProperties": true,
|
|
739
|
+
"required": [
|
|
740
|
+
"status"
|
|
741
|
+
],
|
|
742
|
+
"description": "Asynchronous job status and download location."
|
|
743
|
+
},
|
|
744
|
+
"asyncLifecycle": {
|
|
745
|
+
"startActionId": "panjiva.batch_search_companies",
|
|
746
|
+
"statusActionId": "panjiva.get_batch_job_status"
|
|
747
|
+
}
|
|
748
|
+
},
|
|
749
|
+
{
|
|
750
|
+
"id": "panjiva.get_bulk_job_status",
|
|
751
|
+
"service": "panjiva",
|
|
752
|
+
"name": "get_bulk_job_status",
|
|
753
|
+
"description": "Check a bulk shipment job and retrieve its download URL when ready.",
|
|
754
|
+
"operationType": "read",
|
|
755
|
+
"requiredScopes": [],
|
|
756
|
+
"providerPermissions": [],
|
|
757
|
+
"inputSchema": {
|
|
758
|
+
"type": "object",
|
|
759
|
+
"properties": {
|
|
760
|
+
"job_id": {
|
|
761
|
+
"type": "string",
|
|
762
|
+
"description": "Job ID returned by the corresponding submission action.",
|
|
763
|
+
"format": "uuid"
|
|
764
|
+
}
|
|
765
|
+
},
|
|
766
|
+
"additionalProperties": false,
|
|
767
|
+
"description": "Bulk job to inspect."
|
|
768
|
+
},
|
|
769
|
+
"outputSchema": {
|
|
770
|
+
"type": "object",
|
|
771
|
+
"properties": {
|
|
772
|
+
"id": {
|
|
773
|
+
"type": "string",
|
|
774
|
+
"description": "Job ID returned by the corresponding submission action.",
|
|
775
|
+
"format": "uuid"
|
|
776
|
+
},
|
|
777
|
+
"status": {
|
|
778
|
+
"type": "string",
|
|
779
|
+
"description": "Upstream state: submitted, in_process, fetched, uploaded, notification_sent, or error."
|
|
780
|
+
},
|
|
781
|
+
"download_url": {
|
|
782
|
+
"type": "string",
|
|
783
|
+
"description": "Download URL when ready; pass this URL to a file consumer."
|
|
784
|
+
},
|
|
785
|
+
"last_changed": {
|
|
786
|
+
"type": "string",
|
|
787
|
+
"description": "Time of the latest state change.",
|
|
788
|
+
"format": "date-time"
|
|
789
|
+
},
|
|
790
|
+
"parameters": {
|
|
791
|
+
"type": "object",
|
|
792
|
+
"properties": {},
|
|
793
|
+
"additionalProperties": true,
|
|
794
|
+
"description": "Original job parameters."
|
|
795
|
+
}
|
|
796
|
+
},
|
|
797
|
+
"additionalProperties": true,
|
|
798
|
+
"required": [
|
|
799
|
+
"status"
|
|
800
|
+
],
|
|
801
|
+
"description": "Asynchronous job status and download location."
|
|
802
|
+
},
|
|
803
|
+
"asyncLifecycle": {
|
|
804
|
+
"startActionId": "panjiva.bulk_search_shipments",
|
|
805
|
+
"statusActionId": "panjiva.get_bulk_job_status"
|
|
806
|
+
}
|
|
807
|
+
},
|
|
808
|
+
{
|
|
809
|
+
"id": "panjiva.get_company_network",
|
|
810
|
+
"service": "panjiva",
|
|
811
|
+
"name": "get_company_network",
|
|
812
|
+
"description": "Retrieve a company's top buyers, suppliers and trade statistics from Panjiva.",
|
|
813
|
+
"operationType": "read",
|
|
814
|
+
"requiredScopes": [],
|
|
815
|
+
"providerPermissions": [],
|
|
816
|
+
"inputSchema": {
|
|
817
|
+
"type": "object",
|
|
818
|
+
"properties": {
|
|
819
|
+
"query": {
|
|
820
|
+
"type": "object",
|
|
821
|
+
"properties": {
|
|
822
|
+
"text": {
|
|
823
|
+
"type": "string",
|
|
824
|
+
"description": "Search text. Supports + (AND), | (OR), - (exclude), quoted phrases, trailing *, and parentheses."
|
|
825
|
+
},
|
|
826
|
+
"group": {
|
|
827
|
+
"type": "string",
|
|
828
|
+
"description": "Named search group, such as goods_described, consignee_name, shipper_name, or main. Discover groups with get_data_source_metadata."
|
|
829
|
+
},
|
|
830
|
+
"custom_group": {
|
|
831
|
+
"type": "array",
|
|
832
|
+
"items": {
|
|
833
|
+
"type": "string",
|
|
834
|
+
"description": "Searchable field name."
|
|
835
|
+
},
|
|
836
|
+
"description": "Explicit fields to search instead of a named group."
|
|
837
|
+
},
|
|
838
|
+
"operator": {
|
|
839
|
+
"type": "string",
|
|
840
|
+
"enum": [
|
|
841
|
+
"AND",
|
|
842
|
+
"OR"
|
|
843
|
+
],
|
|
844
|
+
"description": "Boolean operator between search terms; the upstream default is OR."
|
|
845
|
+
},
|
|
846
|
+
"match": {
|
|
847
|
+
"type": "string",
|
|
848
|
+
"enum": [
|
|
849
|
+
"stem",
|
|
850
|
+
"exact"
|
|
851
|
+
],
|
|
852
|
+
"description": "Match word stems or exact terms; the upstream default is stem."
|
|
853
|
+
}
|
|
854
|
+
},
|
|
855
|
+
"additionalProperties": false,
|
|
856
|
+
"required": [
|
|
857
|
+
"text"
|
|
858
|
+
],
|
|
859
|
+
"description": "Free-text search criteria."
|
|
860
|
+
},
|
|
861
|
+
"queries": {
|
|
862
|
+
"type": "array",
|
|
863
|
+
"items": {
|
|
864
|
+
"type": "object",
|
|
865
|
+
"properties": {
|
|
866
|
+
"text": {
|
|
867
|
+
"type": "string",
|
|
868
|
+
"description": "Search text. Supports + (AND), | (OR), - (exclude), quoted phrases, trailing *, and parentheses."
|
|
869
|
+
},
|
|
870
|
+
"group": {
|
|
871
|
+
"type": "string",
|
|
872
|
+
"description": "Named search group, such as goods_described, consignee_name, shipper_name, or main. Discover groups with get_data_source_metadata."
|
|
873
|
+
},
|
|
874
|
+
"custom_group": {
|
|
875
|
+
"type": "array",
|
|
876
|
+
"items": {
|
|
877
|
+
"type": "string",
|
|
878
|
+
"description": "Searchable field name."
|
|
879
|
+
},
|
|
880
|
+
"description": "Explicit fields to search instead of a named group."
|
|
881
|
+
},
|
|
882
|
+
"operator": {
|
|
883
|
+
"type": "string",
|
|
884
|
+
"enum": [
|
|
885
|
+
"AND",
|
|
886
|
+
"OR"
|
|
887
|
+
],
|
|
888
|
+
"description": "Boolean operator between search terms; the upstream default is OR."
|
|
889
|
+
},
|
|
890
|
+
"match": {
|
|
891
|
+
"type": "string",
|
|
892
|
+
"enum": [
|
|
893
|
+
"stem",
|
|
894
|
+
"exact"
|
|
895
|
+
],
|
|
896
|
+
"description": "Match word stems or exact terms; the upstream default is stem."
|
|
897
|
+
}
|
|
898
|
+
},
|
|
899
|
+
"additionalProperties": false,
|
|
900
|
+
"required": [
|
|
901
|
+
"text"
|
|
902
|
+
],
|
|
903
|
+
"description": "Free-text search criteria."
|
|
904
|
+
},
|
|
905
|
+
"description": "Multiple search criteria; every query must match.",
|
|
906
|
+
"maxItems": 500
|
|
907
|
+
},
|
|
908
|
+
"filters": {
|
|
909
|
+
"type": "object",
|
|
910
|
+
"properties": {},
|
|
911
|
+
"additionalProperties": true,
|
|
912
|
+
"description": "Native Panjiva filters, including AND, OR, NOT, ranges, dates and geographic constraints. For example: {record_date:{gte:'2025-01-01'},destination_countries:'United States'}. Discover fields with get_data_source_metadata; syntax: https://panjiva.com/api-guide/data-selection/filters."
|
|
913
|
+
},
|
|
914
|
+
"company_type": {
|
|
915
|
+
"type": "string",
|
|
916
|
+
"enum": [
|
|
917
|
+
"ccn",
|
|
918
|
+
"country_company_name",
|
|
919
|
+
"pid",
|
|
920
|
+
"capiq",
|
|
921
|
+
"ultimate_parent_capiq"
|
|
922
|
+
],
|
|
923
|
+
"description": "Company identifier representation; upstream default is country_company_name."
|
|
924
|
+
},
|
|
925
|
+
"direction": {
|
|
926
|
+
"type": "string",
|
|
927
|
+
"enum": [
|
|
928
|
+
"bidirectional",
|
|
929
|
+
"consignee",
|
|
930
|
+
"shipper"
|
|
931
|
+
],
|
|
932
|
+
"description": "Trade role to search; upstream default is bidirectional."
|
|
933
|
+
},
|
|
934
|
+
"metrics": {
|
|
935
|
+
"type": "array",
|
|
936
|
+
"items": {
|
|
937
|
+
"type": "object",
|
|
938
|
+
"properties": {
|
|
939
|
+
"metric": {
|
|
940
|
+
"type": "string",
|
|
941
|
+
"description": "Numeric field to aggregate, such as value_usd, weight_kg or volume_teu. Available fields depend on the data source."
|
|
942
|
+
},
|
|
943
|
+
"op": {
|
|
944
|
+
"type": "string",
|
|
945
|
+
"enum": [
|
|
946
|
+
"sum",
|
|
947
|
+
"max",
|
|
948
|
+
"avg",
|
|
949
|
+
"min"
|
|
950
|
+
],
|
|
951
|
+
"description": "Statistical aggregation operation."
|
|
952
|
+
}
|
|
953
|
+
},
|
|
954
|
+
"additionalProperties": false,
|
|
955
|
+
"description": "Metric and aggregation operation."
|
|
956
|
+
},
|
|
957
|
+
"description": "Aggregate statistics across matching shipments."
|
|
958
|
+
},
|
|
959
|
+
"size": {
|
|
960
|
+
"type": "integer",
|
|
961
|
+
"minimum": 0,
|
|
962
|
+
"maximum": 5000,
|
|
963
|
+
"description": "Maximum company results per trade direction."
|
|
964
|
+
},
|
|
965
|
+
"sort": {
|
|
966
|
+
"type": "object",
|
|
967
|
+
"properties": {
|
|
968
|
+
"key": {
|
|
969
|
+
"type": "string",
|
|
970
|
+
"description": "Sort by count, field, or an available metric."
|
|
971
|
+
},
|
|
972
|
+
"order": {
|
|
973
|
+
"type": "string",
|
|
974
|
+
"enum": [
|
|
975
|
+
"asc",
|
|
976
|
+
"desc"
|
|
977
|
+
],
|
|
978
|
+
"description": "Ascending or descending order."
|
|
979
|
+
},
|
|
980
|
+
"op": {
|
|
981
|
+
"type": "string",
|
|
982
|
+
"enum": [
|
|
983
|
+
"sum",
|
|
984
|
+
"max",
|
|
985
|
+
"avg",
|
|
986
|
+
"min"
|
|
987
|
+
],
|
|
988
|
+
"description": "Statistical aggregation operation."
|
|
989
|
+
}
|
|
990
|
+
},
|
|
991
|
+
"additionalProperties": false,
|
|
992
|
+
"required": [
|
|
993
|
+
"key"
|
|
994
|
+
],
|
|
995
|
+
"description": "Sort an aggregation; metric keys must also be declared in metrics."
|
|
996
|
+
},
|
|
997
|
+
"company_id": {
|
|
998
|
+
"type": "integer",
|
|
999
|
+
"description": "Company ID whose trade network should be retrieved."
|
|
1000
|
+
}
|
|
1001
|
+
},
|
|
1002
|
+
"additionalProperties": false,
|
|
1003
|
+
"required": [
|
|
1004
|
+
"company_id"
|
|
1005
|
+
],
|
|
1006
|
+
"description": "Company network criteria."
|
|
1007
|
+
},
|
|
1008
|
+
"outputSchema": {
|
|
1009
|
+
"type": "object",
|
|
1010
|
+
"properties": {
|
|
1011
|
+
"network": {
|
|
1012
|
+
"type": "object",
|
|
1013
|
+
"additionalProperties": {
|
|
1014
|
+
"type": "object",
|
|
1015
|
+
"properties": {},
|
|
1016
|
+
"additionalProperties": true,
|
|
1017
|
+
"description": "Company network with top_consignees, top_shippers and stats."
|
|
1018
|
+
},
|
|
1019
|
+
"description": "Trade network keyed by company ID."
|
|
1020
|
+
}
|
|
1021
|
+
},
|
|
1022
|
+
"additionalProperties": false,
|
|
1023
|
+
"description": "Company trade network."
|
|
1024
|
+
}
|
|
1025
|
+
},
|
|
1026
|
+
{
|
|
1027
|
+
"id": "panjiva.get_data_source_metadata",
|
|
1028
|
+
"service": "panjiva",
|
|
1029
|
+
"name": "get_data_source_metadata",
|
|
1030
|
+
"description": "Discover searchable fields, filters, sort keys, metrics, dimensions and refinements for a Panjiva data source.",
|
|
1031
|
+
"operationType": "read",
|
|
1032
|
+
"requiredScopes": [],
|
|
1033
|
+
"providerPermissions": [],
|
|
1034
|
+
"inputSchema": {
|
|
1035
|
+
"type": "object",
|
|
1036
|
+
"properties": {
|
|
1037
|
+
"data_source": {
|
|
1038
|
+
"type": "string",
|
|
1039
|
+
"minLength": 1,
|
|
1040
|
+
"description": "Data source, such as global or us-imports. Use list_data_sources to discover available sources; global covers the last five years."
|
|
1041
|
+
}
|
|
1042
|
+
},
|
|
1043
|
+
"additionalProperties": false,
|
|
1044
|
+
"description": "Data source to inspect."
|
|
1045
|
+
},
|
|
1046
|
+
"outputSchema": {
|
|
1047
|
+
"type": "object",
|
|
1048
|
+
"properties": {
|
|
1049
|
+
"query": {
|
|
1050
|
+
"type": "object",
|
|
1051
|
+
"properties": {},
|
|
1052
|
+
"additionalProperties": true,
|
|
1053
|
+
"description": "Query groups and defaults."
|
|
1054
|
+
},
|
|
1055
|
+
"filters": {
|
|
1056
|
+
"type": "array",
|
|
1057
|
+
"items": {
|
|
1058
|
+
"type": "object",
|
|
1059
|
+
"properties": {},
|
|
1060
|
+
"additionalProperties": true,
|
|
1061
|
+
"description": "Native record with all data-source-specific fields preserved."
|
|
1062
|
+
},
|
|
1063
|
+
"description": "Filter fields and their types."
|
|
1064
|
+
},
|
|
1065
|
+
"sort": {
|
|
1066
|
+
"type": "object",
|
|
1067
|
+
"properties": {},
|
|
1068
|
+
"additionalProperties": true,
|
|
1069
|
+
"description": "Valid sort keys and defaults."
|
|
1070
|
+
},
|
|
1071
|
+
"metrics": {
|
|
1072
|
+
"type": "array",
|
|
1073
|
+
"items": {
|
|
1074
|
+
"type": "object",
|
|
1075
|
+
"properties": {},
|
|
1076
|
+
"additionalProperties": true,
|
|
1077
|
+
"description": "Native record with all data-source-specific fields preserved."
|
|
1078
|
+
},
|
|
1079
|
+
"description": "Available metrics and supported operations."
|
|
1080
|
+
},
|
|
1081
|
+
"dimensions": {
|
|
1082
|
+
"type": "array",
|
|
1083
|
+
"items": {
|
|
1084
|
+
"type": "string",
|
|
1085
|
+
"description": "Dimension field."
|
|
1086
|
+
},
|
|
1087
|
+
"description": "Available dimension fields."
|
|
1088
|
+
},
|
|
1089
|
+
"refinements": {
|
|
1090
|
+
"type": "array",
|
|
1091
|
+
"items": {
|
|
1092
|
+
"type": "string",
|
|
1093
|
+
"description": "Refinement field."
|
|
1094
|
+
},
|
|
1095
|
+
"description": "Available refinement fields."
|
|
1096
|
+
}
|
|
1097
|
+
},
|
|
1098
|
+
"additionalProperties": true,
|
|
1099
|
+
"description": "Data-source query capabilities."
|
|
1100
|
+
}
|
|
1101
|
+
},
|
|
1102
|
+
{
|
|
1103
|
+
"id": "panjiva.get_data_source_schema",
|
|
1104
|
+
"service": "panjiva",
|
|
1105
|
+
"name": "get_data_source_schema",
|
|
1106
|
+
"description": "Retrieve native shipment record schemas for a Panjiva data source.",
|
|
1107
|
+
"operationType": "read",
|
|
1108
|
+
"requiredScopes": [],
|
|
1109
|
+
"providerPermissions": [],
|
|
1110
|
+
"inputSchema": {
|
|
1111
|
+
"type": "object",
|
|
1112
|
+
"properties": {
|
|
1113
|
+
"data_source": {
|
|
1114
|
+
"type": "string",
|
|
1115
|
+
"minLength": 1,
|
|
1116
|
+
"description": "Data source, such as global or us-imports. Use list_data_sources to discover available sources; global covers the last five years."
|
|
1117
|
+
}
|
|
1118
|
+
},
|
|
1119
|
+
"additionalProperties": false,
|
|
1120
|
+
"description": "Data source to inspect."
|
|
1121
|
+
},
|
|
1122
|
+
"outputSchema": {
|
|
1123
|
+
"type": "object",
|
|
1124
|
+
"properties": {
|
|
1125
|
+
"schemas": {
|
|
1126
|
+
"type": "object",
|
|
1127
|
+
"additionalProperties": {
|
|
1128
|
+
"type": "object",
|
|
1129
|
+
"properties": {},
|
|
1130
|
+
"additionalProperties": true,
|
|
1131
|
+
"description": "Native record with all data-source-specific fields preserved."
|
|
1132
|
+
},
|
|
1133
|
+
"description": "Schemas keyed by country and trade direction."
|
|
1134
|
+
}
|
|
1135
|
+
},
|
|
1136
|
+
"additionalProperties": false,
|
|
1137
|
+
"description": "Data-source shipment schemas."
|
|
1138
|
+
}
|
|
1139
|
+
},
|
|
1140
|
+
{
|
|
1141
|
+
"id": "panjiva.get_shipment_refinements",
|
|
1142
|
+
"service": "panjiva",
|
|
1143
|
+
"name": "get_shipment_refinements",
|
|
1144
|
+
"description": "List the most common values of selected shipment attributes for matching Panjiva records.",
|
|
1145
|
+
"operationType": "read",
|
|
1146
|
+
"requiredScopes": [],
|
|
1147
|
+
"providerPermissions": [],
|
|
1148
|
+
"inputSchema": {
|
|
1149
|
+
"type": "object",
|
|
1150
|
+
"properties": {
|
|
1151
|
+
"data_source": {
|
|
1152
|
+
"type": "string",
|
|
1153
|
+
"minLength": 1,
|
|
1154
|
+
"description": "Data source, such as global or us-imports. Use list_data_sources to discover available sources; global covers the last five years."
|
|
1155
|
+
},
|
|
1156
|
+
"query": {
|
|
1157
|
+
"type": "object",
|
|
1158
|
+
"properties": {
|
|
1159
|
+
"text": {
|
|
1160
|
+
"type": "string",
|
|
1161
|
+
"description": "Search text. Supports + (AND), | (OR), - (exclude), quoted phrases, trailing *, and parentheses."
|
|
1162
|
+
},
|
|
1163
|
+
"group": {
|
|
1164
|
+
"type": "string",
|
|
1165
|
+
"description": "Named search group, such as goods_described, consignee_name, shipper_name, or main. Discover groups with get_data_source_metadata."
|
|
1166
|
+
},
|
|
1167
|
+
"custom_group": {
|
|
1168
|
+
"type": "array",
|
|
1169
|
+
"items": {
|
|
1170
|
+
"type": "string",
|
|
1171
|
+
"description": "Searchable field name."
|
|
1172
|
+
},
|
|
1173
|
+
"description": "Explicit fields to search instead of a named group."
|
|
1174
|
+
},
|
|
1175
|
+
"operator": {
|
|
1176
|
+
"type": "string",
|
|
1177
|
+
"enum": [
|
|
1178
|
+
"AND",
|
|
1179
|
+
"OR"
|
|
1180
|
+
],
|
|
1181
|
+
"description": "Boolean operator between search terms; the upstream default is OR."
|
|
1182
|
+
},
|
|
1183
|
+
"match": {
|
|
1184
|
+
"type": "string",
|
|
1185
|
+
"enum": [
|
|
1186
|
+
"stem",
|
|
1187
|
+
"exact"
|
|
1188
|
+
],
|
|
1189
|
+
"description": "Match word stems or exact terms; the upstream default is stem."
|
|
1190
|
+
}
|
|
1191
|
+
},
|
|
1192
|
+
"additionalProperties": false,
|
|
1193
|
+
"required": [
|
|
1194
|
+
"text"
|
|
1195
|
+
],
|
|
1196
|
+
"description": "Free-text search criteria."
|
|
1197
|
+
},
|
|
1198
|
+
"queries": {
|
|
1199
|
+
"type": "array",
|
|
1200
|
+
"items": {
|
|
1201
|
+
"type": "object",
|
|
1202
|
+
"properties": {
|
|
1203
|
+
"text": {
|
|
1204
|
+
"type": "string",
|
|
1205
|
+
"description": "Search text. Supports + (AND), | (OR), - (exclude), quoted phrases, trailing *, and parentheses."
|
|
1206
|
+
},
|
|
1207
|
+
"group": {
|
|
1208
|
+
"type": "string",
|
|
1209
|
+
"description": "Named search group, such as goods_described, consignee_name, shipper_name, or main. Discover groups with get_data_source_metadata."
|
|
1210
|
+
},
|
|
1211
|
+
"custom_group": {
|
|
1212
|
+
"type": "array",
|
|
1213
|
+
"items": {
|
|
1214
|
+
"type": "string",
|
|
1215
|
+
"description": "Searchable field name."
|
|
1216
|
+
},
|
|
1217
|
+
"description": "Explicit fields to search instead of a named group."
|
|
1218
|
+
},
|
|
1219
|
+
"operator": {
|
|
1220
|
+
"type": "string",
|
|
1221
|
+
"enum": [
|
|
1222
|
+
"AND",
|
|
1223
|
+
"OR"
|
|
1224
|
+
],
|
|
1225
|
+
"description": "Boolean operator between search terms; the upstream default is OR."
|
|
1226
|
+
},
|
|
1227
|
+
"match": {
|
|
1228
|
+
"type": "string",
|
|
1229
|
+
"enum": [
|
|
1230
|
+
"stem",
|
|
1231
|
+
"exact"
|
|
1232
|
+
],
|
|
1233
|
+
"description": "Match word stems or exact terms; the upstream default is stem."
|
|
1234
|
+
}
|
|
1235
|
+
},
|
|
1236
|
+
"additionalProperties": false,
|
|
1237
|
+
"required": [
|
|
1238
|
+
"text"
|
|
1239
|
+
],
|
|
1240
|
+
"description": "Free-text search criteria."
|
|
1241
|
+
},
|
|
1242
|
+
"description": "Multiple search criteria; every query must match.",
|
|
1243
|
+
"maxItems": 500
|
|
1244
|
+
},
|
|
1245
|
+
"filters": {
|
|
1246
|
+
"type": "object",
|
|
1247
|
+
"properties": {},
|
|
1248
|
+
"additionalProperties": true,
|
|
1249
|
+
"description": "Native Panjiva filters, including AND, OR, NOT, ranges, dates and geographic constraints. For example: {record_date:{gte:'2025-01-01'},destination_countries:'United States'}. Discover fields with get_data_source_metadata; syntax: https://panjiva.com/api-guide/data-selection/filters."
|
|
1250
|
+
},
|
|
1251
|
+
"fields": {
|
|
1252
|
+
"type": "array",
|
|
1253
|
+
"items": {
|
|
1254
|
+
"type": "string",
|
|
1255
|
+
"description": "Shipment attribute name."
|
|
1256
|
+
},
|
|
1257
|
+
"description": "Attributes whose top values should be returned; discover available refinements with get_data_source_metadata."
|
|
1258
|
+
}
|
|
1259
|
+
},
|
|
1260
|
+
"additionalProperties": false,
|
|
1261
|
+
"required": [
|
|
1262
|
+
"data_source",
|
|
1263
|
+
"fields"
|
|
1264
|
+
],
|
|
1265
|
+
"description": "Shipment refinement criteria."
|
|
1266
|
+
},
|
|
1267
|
+
"outputSchema": {
|
|
1268
|
+
"type": "object",
|
|
1269
|
+
"properties": {
|
|
1270
|
+
"record_count": {
|
|
1271
|
+
"type": "object",
|
|
1272
|
+
"properties": {
|
|
1273
|
+
"total": {
|
|
1274
|
+
"type": "integer",
|
|
1275
|
+
"description": "Total matching records."
|
|
1276
|
+
},
|
|
1277
|
+
"returned": {
|
|
1278
|
+
"type": "integer",
|
|
1279
|
+
"description": "Records returned in this response."
|
|
1280
|
+
}
|
|
1281
|
+
},
|
|
1282
|
+
"additionalProperties": true,
|
|
1283
|
+
"description": "Matching and returned record counts."
|
|
1284
|
+
},
|
|
1285
|
+
"analytics": {
|
|
1286
|
+
"type": "object",
|
|
1287
|
+
"properties": {},
|
|
1288
|
+
"additionalProperties": true,
|
|
1289
|
+
"description": "Panjiva metrics, refinements, time_series or rollup results, keyed by requested fields."
|
|
1290
|
+
}
|
|
1291
|
+
},
|
|
1292
|
+
"additionalProperties": true,
|
|
1293
|
+
"description": "Matching record counts and requested analytics."
|
|
1294
|
+
}
|
|
1295
|
+
},
|
|
1296
|
+
{
|
|
1297
|
+
"id": "panjiva.get_shipment_time_series",
|
|
1298
|
+
"service": "panjiva",
|
|
1299
|
+
"name": "get_shipment_time_series",
|
|
1300
|
+
"description": "Calculate shipment metrics aggregated by week, month, quarter or year.",
|
|
1301
|
+
"operationType": "read",
|
|
1302
|
+
"requiredScopes": [],
|
|
1303
|
+
"providerPermissions": [],
|
|
1304
|
+
"inputSchema": {
|
|
1305
|
+
"type": "object",
|
|
1306
|
+
"properties": {
|
|
1307
|
+
"data_source": {
|
|
1308
|
+
"type": "string",
|
|
1309
|
+
"minLength": 1,
|
|
1310
|
+
"description": "Data source, such as global or us-imports. Use list_data_sources to discover available sources; global covers the last five years."
|
|
1311
|
+
},
|
|
1312
|
+
"query": {
|
|
1313
|
+
"type": "object",
|
|
1314
|
+
"properties": {
|
|
1315
|
+
"text": {
|
|
1316
|
+
"type": "string",
|
|
1317
|
+
"description": "Search text. Supports + (AND), | (OR), - (exclude), quoted phrases, trailing *, and parentheses."
|
|
1318
|
+
},
|
|
1319
|
+
"group": {
|
|
1320
|
+
"type": "string",
|
|
1321
|
+
"description": "Named search group, such as goods_described, consignee_name, shipper_name, or main. Discover groups with get_data_source_metadata."
|
|
1322
|
+
},
|
|
1323
|
+
"custom_group": {
|
|
1324
|
+
"type": "array",
|
|
1325
|
+
"items": {
|
|
1326
|
+
"type": "string",
|
|
1327
|
+
"description": "Searchable field name."
|
|
1328
|
+
},
|
|
1329
|
+
"description": "Explicit fields to search instead of a named group."
|
|
1330
|
+
},
|
|
1331
|
+
"operator": {
|
|
1332
|
+
"type": "string",
|
|
1333
|
+
"enum": [
|
|
1334
|
+
"AND",
|
|
1335
|
+
"OR"
|
|
1336
|
+
],
|
|
1337
|
+
"description": "Boolean operator between search terms; the upstream default is OR."
|
|
1338
|
+
},
|
|
1339
|
+
"match": {
|
|
1340
|
+
"type": "string",
|
|
1341
|
+
"enum": [
|
|
1342
|
+
"stem",
|
|
1343
|
+
"exact"
|
|
1344
|
+
],
|
|
1345
|
+
"description": "Match word stems or exact terms; the upstream default is stem."
|
|
1346
|
+
}
|
|
1347
|
+
},
|
|
1348
|
+
"additionalProperties": false,
|
|
1349
|
+
"required": [
|
|
1350
|
+
"text"
|
|
1351
|
+
],
|
|
1352
|
+
"description": "Free-text search criteria."
|
|
1353
|
+
},
|
|
1354
|
+
"queries": {
|
|
1355
|
+
"type": "array",
|
|
1356
|
+
"items": {
|
|
1357
|
+
"type": "object",
|
|
1358
|
+
"properties": {
|
|
1359
|
+
"text": {
|
|
1360
|
+
"type": "string",
|
|
1361
|
+
"description": "Search text. Supports + (AND), | (OR), - (exclude), quoted phrases, trailing *, and parentheses."
|
|
1362
|
+
},
|
|
1363
|
+
"group": {
|
|
1364
|
+
"type": "string",
|
|
1365
|
+
"description": "Named search group, such as goods_described, consignee_name, shipper_name, or main. Discover groups with get_data_source_metadata."
|
|
1366
|
+
},
|
|
1367
|
+
"custom_group": {
|
|
1368
|
+
"type": "array",
|
|
1369
|
+
"items": {
|
|
1370
|
+
"type": "string",
|
|
1371
|
+
"description": "Searchable field name."
|
|
1372
|
+
},
|
|
1373
|
+
"description": "Explicit fields to search instead of a named group."
|
|
1374
|
+
},
|
|
1375
|
+
"operator": {
|
|
1376
|
+
"type": "string",
|
|
1377
|
+
"enum": [
|
|
1378
|
+
"AND",
|
|
1379
|
+
"OR"
|
|
1380
|
+
],
|
|
1381
|
+
"description": "Boolean operator between search terms; the upstream default is OR."
|
|
1382
|
+
},
|
|
1383
|
+
"match": {
|
|
1384
|
+
"type": "string",
|
|
1385
|
+
"enum": [
|
|
1386
|
+
"stem",
|
|
1387
|
+
"exact"
|
|
1388
|
+
],
|
|
1389
|
+
"description": "Match word stems or exact terms; the upstream default is stem."
|
|
1390
|
+
}
|
|
1391
|
+
},
|
|
1392
|
+
"additionalProperties": false,
|
|
1393
|
+
"required": [
|
|
1394
|
+
"text"
|
|
1395
|
+
],
|
|
1396
|
+
"description": "Free-text search criteria."
|
|
1397
|
+
},
|
|
1398
|
+
"description": "Multiple search criteria; every query must match.",
|
|
1399
|
+
"maxItems": 500
|
|
1400
|
+
},
|
|
1401
|
+
"filters": {
|
|
1402
|
+
"type": "object",
|
|
1403
|
+
"properties": {},
|
|
1404
|
+
"additionalProperties": true,
|
|
1405
|
+
"description": "Native Panjiva filters, including AND, OR, NOT, ranges, dates and geographic constraints. For example: {record_date:{gte:'2025-01-01'},destination_countries:'United States'}. Discover fields with get_data_source_metadata; syntax: https://panjiva.com/api-guide/data-selection/filters."
|
|
1406
|
+
},
|
|
1407
|
+
"metrics": {
|
|
1408
|
+
"type": "array",
|
|
1409
|
+
"items": {
|
|
1410
|
+
"type": "object",
|
|
1411
|
+
"properties": {
|
|
1412
|
+
"metric": {
|
|
1413
|
+
"type": "string",
|
|
1414
|
+
"description": "Numeric field to aggregate, such as value_usd, weight_kg or volume_teu. Available fields depend on the data source."
|
|
1415
|
+
},
|
|
1416
|
+
"op": {
|
|
1417
|
+
"type": "string",
|
|
1418
|
+
"enum": [
|
|
1419
|
+
"sum",
|
|
1420
|
+
"max",
|
|
1421
|
+
"avg",
|
|
1422
|
+
"min"
|
|
1423
|
+
],
|
|
1424
|
+
"description": "Statistical aggregation operation."
|
|
1425
|
+
}
|
|
1426
|
+
},
|
|
1427
|
+
"additionalProperties": false,
|
|
1428
|
+
"description": "Metric and aggregation operation."
|
|
1429
|
+
},
|
|
1430
|
+
"description": "Aggregate statistics across matching shipments."
|
|
1431
|
+
},
|
|
1432
|
+
"interval": {
|
|
1433
|
+
"type": "string",
|
|
1434
|
+
"enum": [
|
|
1435
|
+
"week",
|
|
1436
|
+
"month",
|
|
1437
|
+
"quarter",
|
|
1438
|
+
"year"
|
|
1439
|
+
],
|
|
1440
|
+
"description": "Time-series bucket interval."
|
|
1441
|
+
},
|
|
1442
|
+
"min_date": {
|
|
1443
|
+
"type": "string",
|
|
1444
|
+
"description": "First date included in the time series.",
|
|
1445
|
+
"format": "date"
|
|
1446
|
+
},
|
|
1447
|
+
"max_date": {
|
|
1448
|
+
"type": "string",
|
|
1449
|
+
"description": "Last date included in the time series.",
|
|
1450
|
+
"format": "date"
|
|
1451
|
+
}
|
|
1452
|
+
},
|
|
1453
|
+
"additionalProperties": false,
|
|
1454
|
+
"required": [
|
|
1455
|
+
"data_source",
|
|
1456
|
+
"metrics",
|
|
1457
|
+
"interval"
|
|
1458
|
+
],
|
|
1459
|
+
"description": "Shipment time-series criteria."
|
|
1460
|
+
},
|
|
1461
|
+
"outputSchema": {
|
|
1462
|
+
"type": "object",
|
|
1463
|
+
"properties": {
|
|
1464
|
+
"record_count": {
|
|
1465
|
+
"type": "object",
|
|
1466
|
+
"properties": {
|
|
1467
|
+
"total": {
|
|
1468
|
+
"type": "integer",
|
|
1469
|
+
"description": "Total matching records."
|
|
1470
|
+
},
|
|
1471
|
+
"returned": {
|
|
1472
|
+
"type": "integer",
|
|
1473
|
+
"description": "Records returned in this response."
|
|
1474
|
+
}
|
|
1475
|
+
},
|
|
1476
|
+
"additionalProperties": true,
|
|
1477
|
+
"description": "Matching and returned record counts."
|
|
1478
|
+
},
|
|
1479
|
+
"analytics": {
|
|
1480
|
+
"type": "object",
|
|
1481
|
+
"properties": {},
|
|
1482
|
+
"additionalProperties": true,
|
|
1483
|
+
"description": "Panjiva metrics, refinements, time_series or rollup results, keyed by requested fields."
|
|
1484
|
+
}
|
|
1485
|
+
},
|
|
1486
|
+
"additionalProperties": true,
|
|
1487
|
+
"description": "Matching record counts and requested analytics."
|
|
1488
|
+
}
|
|
1489
|
+
},
|
|
1490
|
+
{
|
|
1491
|
+
"id": "panjiva.list_data_sources",
|
|
1492
|
+
"service": "panjiva",
|
|
1493
|
+
"name": "list_data_sources",
|
|
1494
|
+
"description": "List the Panjiva data sources available to the connected organization.",
|
|
1495
|
+
"operationType": "read",
|
|
1496
|
+
"requiredScopes": [],
|
|
1497
|
+
"providerPermissions": [],
|
|
1498
|
+
"inputSchema": {
|
|
1499
|
+
"type": "object",
|
|
1500
|
+
"properties": {},
|
|
1501
|
+
"additionalProperties": false,
|
|
1502
|
+
"description": "No input is required."
|
|
1503
|
+
},
|
|
1504
|
+
"outputSchema": {
|
|
1505
|
+
"type": "object",
|
|
1506
|
+
"properties": {
|
|
1507
|
+
"data_sources": {
|
|
1508
|
+
"type": "array",
|
|
1509
|
+
"items": {
|
|
1510
|
+
"type": "string",
|
|
1511
|
+
"description": "Data-source identifier."
|
|
1512
|
+
},
|
|
1513
|
+
"description": "Available data-source identifiers."
|
|
1514
|
+
}
|
|
1515
|
+
},
|
|
1516
|
+
"additionalProperties": true,
|
|
1517
|
+
"description": "Available data sources."
|
|
1518
|
+
}
|
|
1519
|
+
},
|
|
1520
|
+
{
|
|
1521
|
+
"id": "panjiva.lookup_companies",
|
|
1522
|
+
"service": "panjiva",
|
|
1523
|
+
"name": "lookup_companies",
|
|
1524
|
+
"description": "Retrieve Panjiva company entities by company IDs and identifier representation.",
|
|
1525
|
+
"operationType": "read",
|
|
1526
|
+
"requiredScopes": [],
|
|
1527
|
+
"providerPermissions": [],
|
|
1528
|
+
"inputSchema": {
|
|
1529
|
+
"type": "object",
|
|
1530
|
+
"properties": {
|
|
1531
|
+
"company_ids": {
|
|
1532
|
+
"type": "array",
|
|
1533
|
+
"items": {
|
|
1534
|
+
"type": "integer",
|
|
1535
|
+
"description": "Company ID."
|
|
1536
|
+
},
|
|
1537
|
+
"description": "Company IDs to retrieve.",
|
|
1538
|
+
"minItems": 1
|
|
1539
|
+
},
|
|
1540
|
+
"company_type": {
|
|
1541
|
+
"type": "string",
|
|
1542
|
+
"enum": [
|
|
1543
|
+
"ccn",
|
|
1544
|
+
"country_company_name",
|
|
1545
|
+
"pid",
|
|
1546
|
+
"capiq",
|
|
1547
|
+
"ultimate_parent_capiq"
|
|
1548
|
+
],
|
|
1549
|
+
"description": "Company identifier representation; upstream default is country_company_name."
|
|
1550
|
+
}
|
|
1551
|
+
},
|
|
1552
|
+
"additionalProperties": false,
|
|
1553
|
+
"required": [
|
|
1554
|
+
"company_ids"
|
|
1555
|
+
],
|
|
1556
|
+
"description": "Company lookup identifiers."
|
|
1557
|
+
},
|
|
1558
|
+
"outputSchema": {
|
|
1559
|
+
"type": "object",
|
|
1560
|
+
"properties": {
|
|
1561
|
+
"companies": {
|
|
1562
|
+
"type": "array",
|
|
1563
|
+
"items": {
|
|
1564
|
+
"type": "object",
|
|
1565
|
+
"properties": {},
|
|
1566
|
+
"additionalProperties": true,
|
|
1567
|
+
"description": "Native company entity, trade statistics and requested aggregations."
|
|
1568
|
+
},
|
|
1569
|
+
"description": "Requested company entities."
|
|
1570
|
+
}
|
|
1571
|
+
},
|
|
1572
|
+
"additionalProperties": true,
|
|
1573
|
+
"description": "Company lookup results."
|
|
1574
|
+
}
|
|
1575
|
+
},
|
|
1576
|
+
{
|
|
1577
|
+
"id": "panjiva.parse_hs_codes",
|
|
1578
|
+
"service": "panjiva",
|
|
1579
|
+
"name": "parse_hs_codes",
|
|
1580
|
+
"description": "Identify HS codes from a product description using the Panjiva commodity coder. Optionally restrict the HS prefix and enable parser, manual rules or classifier methods; the first matching method supplies the results.",
|
|
1581
|
+
"operationType": "read",
|
|
1582
|
+
"requiredScopes": [],
|
|
1583
|
+
"providerPermissions": [],
|
|
1584
|
+
"inputSchema": {
|
|
1585
|
+
"type": "object",
|
|
1586
|
+
"properties": {
|
|
1587
|
+
"description": {
|
|
1588
|
+
"type": "string",
|
|
1589
|
+
"description": "Product description to classify into HS codes."
|
|
1590
|
+
},
|
|
1591
|
+
"partial_hs": {
|
|
1592
|
+
"type": "string",
|
|
1593
|
+
"description": "Optional two- or four-digit HS code prefix that restricts classification results.",
|
|
1594
|
+
"pattern": "^(?:[0-9]{2}|[0-9]{4})$"
|
|
1595
|
+
},
|
|
1596
|
+
"use_parser": {
|
|
1597
|
+
"type": "boolean",
|
|
1598
|
+
"description": "Whether to extract HS codes already present in the description."
|
|
1599
|
+
},
|
|
1600
|
+
"use_manual_logic": {
|
|
1601
|
+
"type": "boolean",
|
|
1602
|
+
"description": "Whether to match predefined classification rules."
|
|
1603
|
+
},
|
|
1604
|
+
"use_classifier": {
|
|
1605
|
+
"type": "boolean",
|
|
1606
|
+
"description": "Whether to use the machine-learning HS classifier."
|
|
1607
|
+
}
|
|
1608
|
+
},
|
|
1609
|
+
"additionalProperties": false,
|
|
1610
|
+
"required": [
|
|
1611
|
+
"description"
|
|
1612
|
+
],
|
|
1613
|
+
"description": "Commodity coding request."
|
|
1614
|
+
},
|
|
1615
|
+
"outputSchema": {
|
|
1616
|
+
"type": "object",
|
|
1617
|
+
"properties": {
|
|
1618
|
+
"result_count": {
|
|
1619
|
+
"type": "number",
|
|
1620
|
+
"description": "Number of classification results reported by Panjiva."
|
|
1621
|
+
},
|
|
1622
|
+
"results": {
|
|
1623
|
+
"type": "array",
|
|
1624
|
+
"items": {
|
|
1625
|
+
"type": "object",
|
|
1626
|
+
"properties": {
|
|
1627
|
+
"predCode": {
|
|
1628
|
+
"type": "string",
|
|
1629
|
+
"description": "Predicted HS code."
|
|
1630
|
+
},
|
|
1631
|
+
"description": {
|
|
1632
|
+
"type": "string",
|
|
1633
|
+
"description": "Description associated with the predicted code."
|
|
1634
|
+
},
|
|
1635
|
+
"confidence": {
|
|
1636
|
+
"type": "number",
|
|
1637
|
+
"description": "Confidence value reported by Panjiva."
|
|
1638
|
+
},
|
|
1639
|
+
"source": {
|
|
1640
|
+
"type": "string",
|
|
1641
|
+
"description": "Classification method that produced the prediction."
|
|
1642
|
+
}
|
|
1643
|
+
},
|
|
1644
|
+
"additionalProperties": true,
|
|
1645
|
+
"description": "One HS code prediction."
|
|
1646
|
+
},
|
|
1647
|
+
"description": "HS code classification candidates."
|
|
1648
|
+
}
|
|
1649
|
+
},
|
|
1650
|
+
"additionalProperties": true,
|
|
1651
|
+
"description": "Commodity coding results."
|
|
1652
|
+
}
|
|
1653
|
+
},
|
|
1654
|
+
{
|
|
1655
|
+
"id": "panjiva.parse_many_hs_codes",
|
|
1656
|
+
"service": "panjiva",
|
|
1657
|
+
"name": "parse_many_hs_codes",
|
|
1658
|
+
"description": "Call Panjiva's Parse Many commodity coder and return per-item HS codes and classifier metadata. The published request schema defines items as an object with description, optional marks and partial_hs; pass that documented object shape.",
|
|
1659
|
+
"operationType": "read",
|
|
1660
|
+
"requiredScopes": [],
|
|
1661
|
+
"providerPermissions": [],
|
|
1662
|
+
"inputSchema": {
|
|
1663
|
+
"type": "object",
|
|
1664
|
+
"properties": {
|
|
1665
|
+
"items": {
|
|
1666
|
+
"type": "object",
|
|
1667
|
+
"properties": {
|
|
1668
|
+
"description": {
|
|
1669
|
+
"type": "string",
|
|
1670
|
+
"description": "Product description to classify into HS codes."
|
|
1671
|
+
},
|
|
1672
|
+
"marks": {
|
|
1673
|
+
"type": "string",
|
|
1674
|
+
"description": "Shipment marks text accompanying the product description."
|
|
1675
|
+
},
|
|
1676
|
+
"partial_hs": {
|
|
1677
|
+
"type": "string",
|
|
1678
|
+
"description": "Optional two- or four-digit HS code prefix that restricts classification results.",
|
|
1679
|
+
"pattern": "^(?:[0-9]{2}|[0-9]{4})$"
|
|
1680
|
+
}
|
|
1681
|
+
},
|
|
1682
|
+
"additionalProperties": false,
|
|
1683
|
+
"required": [
|
|
1684
|
+
"description"
|
|
1685
|
+
],
|
|
1686
|
+
"description": "Commodity item object as defined by the official Parse Many request schema."
|
|
1687
|
+
}
|
|
1688
|
+
},
|
|
1689
|
+
"additionalProperties": false,
|
|
1690
|
+
"description": "Parse Many commodity coding request."
|
|
1691
|
+
},
|
|
1692
|
+
"outputSchema": {
|
|
1693
|
+
"type": "object",
|
|
1694
|
+
"properties": {
|
|
1695
|
+
"classifier_training_date": {
|
|
1696
|
+
"type": "string",
|
|
1697
|
+
"description": "Classifier training date reported by Panjiva."
|
|
1698
|
+
},
|
|
1699
|
+
"classifier_version": {
|
|
1700
|
+
"type": "string",
|
|
1701
|
+
"description": "Classifier model version."
|
|
1702
|
+
},
|
|
1703
|
+
"items": {
|
|
1704
|
+
"type": "array",
|
|
1705
|
+
"items": {
|
|
1706
|
+
"type": "object",
|
|
1707
|
+
"properties": {
|
|
1708
|
+
"parsed_hs_codes": {
|
|
1709
|
+
"type": "array",
|
|
1710
|
+
"items": {
|
|
1711
|
+
"type": "string",
|
|
1712
|
+
"description": "HS code."
|
|
1713
|
+
},
|
|
1714
|
+
"description": "HS codes returned by this classification method."
|
|
1715
|
+
},
|
|
1716
|
+
"piers_override": {
|
|
1717
|
+
"type": "array",
|
|
1718
|
+
"items": {
|
|
1719
|
+
"type": "string",
|
|
1720
|
+
"description": "HS code."
|
|
1721
|
+
},
|
|
1722
|
+
"description": "HS codes returned by this classification method."
|
|
1723
|
+
},
|
|
1724
|
+
"panjiva_override": {
|
|
1725
|
+
"type": "array",
|
|
1726
|
+
"items": {
|
|
1727
|
+
"type": "string",
|
|
1728
|
+
"description": "HS code."
|
|
1729
|
+
},
|
|
1730
|
+
"description": "HS codes returned by this classification method."
|
|
1731
|
+
},
|
|
1732
|
+
"classifier_codes": {
|
|
1733
|
+
"type": "array",
|
|
1734
|
+
"items": {
|
|
1735
|
+
"type": "object",
|
|
1736
|
+
"properties": {
|
|
1737
|
+
"hs_code": {
|
|
1738
|
+
"type": "string",
|
|
1739
|
+
"description": "Predicted HS code."
|
|
1740
|
+
},
|
|
1741
|
+
"confidence": {
|
|
1742
|
+
"type": "number",
|
|
1743
|
+
"description": "Confidence value reported by Panjiva."
|
|
1744
|
+
}
|
|
1745
|
+
},
|
|
1746
|
+
"additionalProperties": true,
|
|
1747
|
+
"description": "One classifier prediction."
|
|
1748
|
+
},
|
|
1749
|
+
"description": "HS codes predicted by the classifier."
|
|
1750
|
+
}
|
|
1751
|
+
},
|
|
1752
|
+
"additionalProperties": true,
|
|
1753
|
+
"description": "Classification results for one commodity item."
|
|
1754
|
+
},
|
|
1755
|
+
"description": "Per-item commodity classification results."
|
|
1756
|
+
}
|
|
1757
|
+
},
|
|
1758
|
+
"additionalProperties": true,
|
|
1759
|
+
"description": "Parse Many classification results and model metadata."
|
|
1760
|
+
}
|
|
1761
|
+
},
|
|
1762
|
+
{
|
|
1763
|
+
"id": "panjiva.rollup_companies",
|
|
1764
|
+
"service": "panjiva",
|
|
1765
|
+
"name": "rollup_companies",
|
|
1766
|
+
"description": "Aggregate trade records for selected companies into up to three grouping dimensions.",
|
|
1767
|
+
"operationType": "read",
|
|
1768
|
+
"requiredScopes": [],
|
|
1769
|
+
"providerPermissions": [],
|
|
1770
|
+
"inputSchema": {
|
|
1771
|
+
"type": "object",
|
|
1772
|
+
"properties": {
|
|
1773
|
+
"query": {
|
|
1774
|
+
"type": "object",
|
|
1775
|
+
"properties": {
|
|
1776
|
+
"text": {
|
|
1777
|
+
"type": "string",
|
|
1778
|
+
"description": "Search text. Supports + (AND), | (OR), - (exclude), quoted phrases, trailing *, and parentheses."
|
|
1779
|
+
},
|
|
1780
|
+
"group": {
|
|
1781
|
+
"type": "string",
|
|
1782
|
+
"description": "Named search group, such as goods_described, consignee_name, shipper_name, or main. Discover groups with get_data_source_metadata."
|
|
1783
|
+
},
|
|
1784
|
+
"custom_group": {
|
|
1785
|
+
"type": "array",
|
|
1786
|
+
"items": {
|
|
1787
|
+
"type": "string",
|
|
1788
|
+
"description": "Searchable field name."
|
|
1789
|
+
},
|
|
1790
|
+
"description": "Explicit fields to search instead of a named group."
|
|
1791
|
+
},
|
|
1792
|
+
"operator": {
|
|
1793
|
+
"type": "string",
|
|
1794
|
+
"enum": [
|
|
1795
|
+
"AND",
|
|
1796
|
+
"OR"
|
|
1797
|
+
],
|
|
1798
|
+
"description": "Boolean operator between search terms; the upstream default is OR."
|
|
1799
|
+
},
|
|
1800
|
+
"match": {
|
|
1801
|
+
"type": "string",
|
|
1802
|
+
"enum": [
|
|
1803
|
+
"stem",
|
|
1804
|
+
"exact"
|
|
1805
|
+
],
|
|
1806
|
+
"description": "Match word stems or exact terms; the upstream default is stem."
|
|
1807
|
+
}
|
|
1808
|
+
},
|
|
1809
|
+
"additionalProperties": false,
|
|
1810
|
+
"required": [
|
|
1811
|
+
"text"
|
|
1812
|
+
],
|
|
1813
|
+
"description": "Free-text search criteria."
|
|
1814
|
+
},
|
|
1815
|
+
"queries": {
|
|
1816
|
+
"type": "array",
|
|
1817
|
+
"items": {
|
|
1818
|
+
"type": "object",
|
|
1819
|
+
"properties": {
|
|
1820
|
+
"text": {
|
|
1821
|
+
"type": "string",
|
|
1822
|
+
"description": "Search text. Supports + (AND), | (OR), - (exclude), quoted phrases, trailing *, and parentheses."
|
|
1823
|
+
},
|
|
1824
|
+
"group": {
|
|
1825
|
+
"type": "string",
|
|
1826
|
+
"description": "Named search group, such as goods_described, consignee_name, shipper_name, or main. Discover groups with get_data_source_metadata."
|
|
1827
|
+
},
|
|
1828
|
+
"custom_group": {
|
|
1829
|
+
"type": "array",
|
|
1830
|
+
"items": {
|
|
1831
|
+
"type": "string",
|
|
1832
|
+
"description": "Searchable field name."
|
|
1833
|
+
},
|
|
1834
|
+
"description": "Explicit fields to search instead of a named group."
|
|
1835
|
+
},
|
|
1836
|
+
"operator": {
|
|
1837
|
+
"type": "string",
|
|
1838
|
+
"enum": [
|
|
1839
|
+
"AND",
|
|
1840
|
+
"OR"
|
|
1841
|
+
],
|
|
1842
|
+
"description": "Boolean operator between search terms; the upstream default is OR."
|
|
1843
|
+
},
|
|
1844
|
+
"match": {
|
|
1845
|
+
"type": "string",
|
|
1846
|
+
"enum": [
|
|
1847
|
+
"stem",
|
|
1848
|
+
"exact"
|
|
1849
|
+
],
|
|
1850
|
+
"description": "Match word stems or exact terms; the upstream default is stem."
|
|
1851
|
+
}
|
|
1852
|
+
},
|
|
1853
|
+
"additionalProperties": false,
|
|
1854
|
+
"required": [
|
|
1855
|
+
"text"
|
|
1856
|
+
],
|
|
1857
|
+
"description": "Free-text search criteria."
|
|
1858
|
+
},
|
|
1859
|
+
"description": "Multiple search criteria; every query must match.",
|
|
1860
|
+
"maxItems": 500
|
|
1861
|
+
},
|
|
1862
|
+
"filters": {
|
|
1863
|
+
"type": "object",
|
|
1864
|
+
"properties": {},
|
|
1865
|
+
"additionalProperties": true,
|
|
1866
|
+
"description": "Native Panjiva filters, including AND, OR, NOT, ranges, dates and geographic constraints. For example: {record_date:{gte:'2025-01-01'},destination_countries:'United States'}. Discover fields with get_data_source_metadata; syntax: https://panjiva.com/api-guide/data-selection/filters."
|
|
1867
|
+
},
|
|
1868
|
+
"company_type": {
|
|
1869
|
+
"type": "string",
|
|
1870
|
+
"enum": [
|
|
1871
|
+
"ccn",
|
|
1872
|
+
"country_company_name",
|
|
1873
|
+
"pid",
|
|
1874
|
+
"capiq",
|
|
1875
|
+
"ultimate_parent_capiq"
|
|
1876
|
+
],
|
|
1877
|
+
"description": "Company identifier representation; upstream default is country_company_name."
|
|
1878
|
+
},
|
|
1879
|
+
"direction": {
|
|
1880
|
+
"type": "string",
|
|
1881
|
+
"enum": [
|
|
1882
|
+
"bidirectional",
|
|
1883
|
+
"consignee",
|
|
1884
|
+
"shipper"
|
|
1885
|
+
],
|
|
1886
|
+
"description": "Trade role to search; upstream default is bidirectional."
|
|
1887
|
+
},
|
|
1888
|
+
"metrics": {
|
|
1889
|
+
"type": "array",
|
|
1890
|
+
"items": {
|
|
1891
|
+
"type": "object",
|
|
1892
|
+
"properties": {
|
|
1893
|
+
"metric": {
|
|
1894
|
+
"type": "string",
|
|
1895
|
+
"description": "Numeric field to aggregate, such as value_usd, weight_kg or volume_teu. Available fields depend on the data source."
|
|
1896
|
+
},
|
|
1897
|
+
"op": {
|
|
1898
|
+
"type": "string",
|
|
1899
|
+
"enum": [
|
|
1900
|
+
"sum",
|
|
1901
|
+
"max",
|
|
1902
|
+
"avg",
|
|
1903
|
+
"min"
|
|
1904
|
+
],
|
|
1905
|
+
"description": "Statistical aggregation operation."
|
|
1906
|
+
}
|
|
1907
|
+
},
|
|
1908
|
+
"additionalProperties": false,
|
|
1909
|
+
"description": "Metric and aggregation operation."
|
|
1910
|
+
},
|
|
1911
|
+
"description": "Aggregate statistics across matching shipments."
|
|
1912
|
+
},
|
|
1913
|
+
"company_ids": {
|
|
1914
|
+
"type": "array",
|
|
1915
|
+
"items": {
|
|
1916
|
+
"type": "integer",
|
|
1917
|
+
"description": "Company ID."
|
|
1918
|
+
},
|
|
1919
|
+
"description": "Company IDs to analyze."
|
|
1920
|
+
},
|
|
1921
|
+
"dimensions": {
|
|
1922
|
+
"type": "array",
|
|
1923
|
+
"items": {
|
|
1924
|
+
"type": "object",
|
|
1925
|
+
"properties": {
|
|
1926
|
+
"field": {
|
|
1927
|
+
"type": "string",
|
|
1928
|
+
"description": "Field to group by; discover available dimensions with get_data_source_metadata."
|
|
1929
|
+
},
|
|
1930
|
+
"include_missing": {
|
|
1931
|
+
"type": "boolean",
|
|
1932
|
+
"description": "Include missing values as NO_VALUE buckets."
|
|
1933
|
+
},
|
|
1934
|
+
"sort": {
|
|
1935
|
+
"type": "object",
|
|
1936
|
+
"properties": {
|
|
1937
|
+
"key": {
|
|
1938
|
+
"type": "string",
|
|
1939
|
+
"description": "Sort by count, field, or an available metric."
|
|
1940
|
+
},
|
|
1941
|
+
"order": {
|
|
1942
|
+
"type": "string",
|
|
1943
|
+
"enum": [
|
|
1944
|
+
"asc",
|
|
1945
|
+
"desc"
|
|
1946
|
+
],
|
|
1947
|
+
"description": "Ascending or descending order."
|
|
1948
|
+
},
|
|
1949
|
+
"op": {
|
|
1950
|
+
"type": "string",
|
|
1951
|
+
"enum": [
|
|
1952
|
+
"sum",
|
|
1953
|
+
"max",
|
|
1954
|
+
"avg",
|
|
1955
|
+
"min"
|
|
1956
|
+
],
|
|
1957
|
+
"description": "Statistical aggregation operation."
|
|
1958
|
+
}
|
|
1959
|
+
},
|
|
1960
|
+
"additionalProperties": false,
|
|
1961
|
+
"required": [
|
|
1962
|
+
"key"
|
|
1963
|
+
],
|
|
1964
|
+
"description": "Sort an aggregation; metric keys must also be declared in metrics."
|
|
1965
|
+
},
|
|
1966
|
+
"size": {
|
|
1967
|
+
"type": "integer",
|
|
1968
|
+
"minimum": 0,
|
|
1969
|
+
"maximum": 100,
|
|
1970
|
+
"description": "Maximum buckets in this dimension; upstream default is 10."
|
|
1971
|
+
},
|
|
1972
|
+
"offset": {
|
|
1973
|
+
"type": "integer",
|
|
1974
|
+
"minimum": 0,
|
|
1975
|
+
"maximum": 999,
|
|
1976
|
+
"description": "First-dimension bucket offset; upstream default is 0."
|
|
1977
|
+
}
|
|
1978
|
+
},
|
|
1979
|
+
"additionalProperties": false,
|
|
1980
|
+
"required": [
|
|
1981
|
+
"field",
|
|
1982
|
+
"sort"
|
|
1983
|
+
],
|
|
1984
|
+
"description": "One grouping dimension."
|
|
1985
|
+
},
|
|
1986
|
+
"description": "One to three successive grouping dimensions. Only the first dimension supports offset; size plus offset cannot exceed 1000.",
|
|
1987
|
+
"minItems": 1,
|
|
1988
|
+
"maxItems": 3
|
|
1989
|
+
}
|
|
1990
|
+
},
|
|
1991
|
+
"additionalProperties": false,
|
|
1992
|
+
"required": [
|
|
1993
|
+
"dimensions"
|
|
1994
|
+
],
|
|
1995
|
+
"description": "Company rollup criteria."
|
|
1996
|
+
},
|
|
1997
|
+
"outputSchema": {
|
|
1998
|
+
"type": "object",
|
|
1999
|
+
"properties": {
|
|
2000
|
+
"consignees": {
|
|
2001
|
+
"type": "array",
|
|
2002
|
+
"items": {
|
|
2003
|
+
"type": "object",
|
|
2004
|
+
"properties": {},
|
|
2005
|
+
"additionalProperties": true,
|
|
2006
|
+
"description": "Native company entity, trade statistics and requested aggregations."
|
|
2007
|
+
},
|
|
2008
|
+
"description": "Matching buyers or consignees."
|
|
2009
|
+
},
|
|
2010
|
+
"shippers": {
|
|
2011
|
+
"type": "array",
|
|
2012
|
+
"items": {
|
|
2013
|
+
"type": "object",
|
|
2014
|
+
"properties": {},
|
|
2015
|
+
"additionalProperties": true,
|
|
2016
|
+
"description": "Native company entity, trade statistics and requested aggregations."
|
|
2017
|
+
},
|
|
2018
|
+
"description": "Matching suppliers or shippers."
|
|
2019
|
+
}
|
|
2020
|
+
},
|
|
2021
|
+
"additionalProperties": true,
|
|
2022
|
+
"description": "Company results separated by trade role."
|
|
2023
|
+
}
|
|
2024
|
+
},
|
|
2025
|
+
{
|
|
2026
|
+
"id": "panjiva.rollup_shipments",
|
|
2027
|
+
"service": "panjiva",
|
|
2028
|
+
"name": "rollup_shipments",
|
|
2029
|
+
"description": "Group matching shipments into up to three dimensions with metrics and optional time-series aggregation.",
|
|
2030
|
+
"operationType": "read",
|
|
2031
|
+
"requiredScopes": [],
|
|
2032
|
+
"providerPermissions": [],
|
|
2033
|
+
"inputSchema": {
|
|
2034
|
+
"type": "object",
|
|
2035
|
+
"properties": {
|
|
2036
|
+
"data_source": {
|
|
2037
|
+
"type": "string",
|
|
2038
|
+
"minLength": 1,
|
|
2039
|
+
"description": "Data source, such as global or us-imports. Use list_data_sources to discover available sources; global covers the last five years."
|
|
2040
|
+
},
|
|
2041
|
+
"query": {
|
|
2042
|
+
"type": "object",
|
|
2043
|
+
"properties": {
|
|
2044
|
+
"text": {
|
|
2045
|
+
"type": "string",
|
|
2046
|
+
"description": "Search text. Supports + (AND), | (OR), - (exclude), quoted phrases, trailing *, and parentheses."
|
|
2047
|
+
},
|
|
2048
|
+
"group": {
|
|
2049
|
+
"type": "string",
|
|
2050
|
+
"description": "Named search group, such as goods_described, consignee_name, shipper_name, or main. Discover groups with get_data_source_metadata."
|
|
2051
|
+
},
|
|
2052
|
+
"custom_group": {
|
|
2053
|
+
"type": "array",
|
|
2054
|
+
"items": {
|
|
2055
|
+
"type": "string",
|
|
2056
|
+
"description": "Searchable field name."
|
|
2057
|
+
},
|
|
2058
|
+
"description": "Explicit fields to search instead of a named group."
|
|
2059
|
+
},
|
|
2060
|
+
"operator": {
|
|
2061
|
+
"type": "string",
|
|
2062
|
+
"enum": [
|
|
2063
|
+
"AND",
|
|
2064
|
+
"OR"
|
|
2065
|
+
],
|
|
2066
|
+
"description": "Boolean operator between search terms; the upstream default is OR."
|
|
2067
|
+
},
|
|
2068
|
+
"match": {
|
|
2069
|
+
"type": "string",
|
|
2070
|
+
"enum": [
|
|
2071
|
+
"stem",
|
|
2072
|
+
"exact"
|
|
2073
|
+
],
|
|
2074
|
+
"description": "Match word stems or exact terms; the upstream default is stem."
|
|
2075
|
+
}
|
|
2076
|
+
},
|
|
2077
|
+
"additionalProperties": false,
|
|
2078
|
+
"required": [
|
|
2079
|
+
"text"
|
|
2080
|
+
],
|
|
2081
|
+
"description": "Free-text search criteria."
|
|
2082
|
+
},
|
|
2083
|
+
"queries": {
|
|
2084
|
+
"type": "array",
|
|
2085
|
+
"items": {
|
|
2086
|
+
"type": "object",
|
|
2087
|
+
"properties": {
|
|
2088
|
+
"text": {
|
|
2089
|
+
"type": "string",
|
|
2090
|
+
"description": "Search text. Supports + (AND), | (OR), - (exclude), quoted phrases, trailing *, and parentheses."
|
|
2091
|
+
},
|
|
2092
|
+
"group": {
|
|
2093
|
+
"type": "string",
|
|
2094
|
+
"description": "Named search group, such as goods_described, consignee_name, shipper_name, or main. Discover groups with get_data_source_metadata."
|
|
2095
|
+
},
|
|
2096
|
+
"custom_group": {
|
|
2097
|
+
"type": "array",
|
|
2098
|
+
"items": {
|
|
2099
|
+
"type": "string",
|
|
2100
|
+
"description": "Searchable field name."
|
|
2101
|
+
},
|
|
2102
|
+
"description": "Explicit fields to search instead of a named group."
|
|
2103
|
+
},
|
|
2104
|
+
"operator": {
|
|
2105
|
+
"type": "string",
|
|
2106
|
+
"enum": [
|
|
2107
|
+
"AND",
|
|
2108
|
+
"OR"
|
|
2109
|
+
],
|
|
2110
|
+
"description": "Boolean operator between search terms; the upstream default is OR."
|
|
2111
|
+
},
|
|
2112
|
+
"match": {
|
|
2113
|
+
"type": "string",
|
|
2114
|
+
"enum": [
|
|
2115
|
+
"stem",
|
|
2116
|
+
"exact"
|
|
2117
|
+
],
|
|
2118
|
+
"description": "Match word stems or exact terms; the upstream default is stem."
|
|
2119
|
+
}
|
|
2120
|
+
},
|
|
2121
|
+
"additionalProperties": false,
|
|
2122
|
+
"required": [
|
|
2123
|
+
"text"
|
|
2124
|
+
],
|
|
2125
|
+
"description": "Free-text search criteria."
|
|
2126
|
+
},
|
|
2127
|
+
"description": "Multiple search criteria; every query must match.",
|
|
2128
|
+
"maxItems": 500
|
|
2129
|
+
},
|
|
2130
|
+
"filters": {
|
|
2131
|
+
"type": "object",
|
|
2132
|
+
"properties": {},
|
|
2133
|
+
"additionalProperties": true,
|
|
2134
|
+
"description": "Native Panjiva filters, including AND, OR, NOT, ranges, dates and geographic constraints. For example: {record_date:{gte:'2025-01-01'},destination_countries:'United States'}. Discover fields with get_data_source_metadata; syntax: https://panjiva.com/api-guide/data-selection/filters."
|
|
2135
|
+
},
|
|
2136
|
+
"metrics": {
|
|
2137
|
+
"type": "array",
|
|
2138
|
+
"items": {
|
|
2139
|
+
"type": "object",
|
|
2140
|
+
"properties": {
|
|
2141
|
+
"metric": {
|
|
2142
|
+
"type": "string",
|
|
2143
|
+
"description": "Numeric field to aggregate, such as value_usd, weight_kg or volume_teu. Available fields depend on the data source."
|
|
2144
|
+
},
|
|
2145
|
+
"op": {
|
|
2146
|
+
"type": "string",
|
|
2147
|
+
"enum": [
|
|
2148
|
+
"sum",
|
|
2149
|
+
"max",
|
|
2150
|
+
"avg",
|
|
2151
|
+
"min"
|
|
2152
|
+
],
|
|
2153
|
+
"description": "Statistical aggregation operation."
|
|
2154
|
+
}
|
|
2155
|
+
},
|
|
2156
|
+
"additionalProperties": false,
|
|
2157
|
+
"description": "Metric and aggregation operation."
|
|
2158
|
+
},
|
|
2159
|
+
"description": "Aggregate statistics across matching shipments."
|
|
2160
|
+
},
|
|
2161
|
+
"dimensions": {
|
|
2162
|
+
"type": "array",
|
|
2163
|
+
"items": {
|
|
2164
|
+
"type": "object",
|
|
2165
|
+
"properties": {
|
|
2166
|
+
"field": {
|
|
2167
|
+
"type": "string",
|
|
2168
|
+
"description": "Field to group by; discover available dimensions with get_data_source_metadata."
|
|
2169
|
+
},
|
|
2170
|
+
"include_missing": {
|
|
2171
|
+
"type": "boolean",
|
|
2172
|
+
"description": "Include missing values as NO_VALUE buckets."
|
|
2173
|
+
},
|
|
2174
|
+
"sort": {
|
|
2175
|
+
"type": "object",
|
|
2176
|
+
"properties": {
|
|
2177
|
+
"key": {
|
|
2178
|
+
"type": "string",
|
|
2179
|
+
"description": "Sort by count, field, or an available metric."
|
|
2180
|
+
},
|
|
2181
|
+
"order": {
|
|
2182
|
+
"type": "string",
|
|
2183
|
+
"enum": [
|
|
2184
|
+
"asc",
|
|
2185
|
+
"desc"
|
|
2186
|
+
],
|
|
2187
|
+
"description": "Ascending or descending order."
|
|
2188
|
+
},
|
|
2189
|
+
"op": {
|
|
2190
|
+
"type": "string",
|
|
2191
|
+
"enum": [
|
|
2192
|
+
"sum",
|
|
2193
|
+
"max",
|
|
2194
|
+
"avg",
|
|
2195
|
+
"min"
|
|
2196
|
+
],
|
|
2197
|
+
"description": "Statistical aggregation operation."
|
|
2198
|
+
}
|
|
2199
|
+
},
|
|
2200
|
+
"additionalProperties": false,
|
|
2201
|
+
"required": [
|
|
2202
|
+
"key"
|
|
2203
|
+
],
|
|
2204
|
+
"description": "Sort an aggregation; metric keys must also be declared in metrics."
|
|
2205
|
+
},
|
|
2206
|
+
"size": {
|
|
2207
|
+
"type": "integer",
|
|
2208
|
+
"minimum": 0,
|
|
2209
|
+
"maximum": 100,
|
|
2210
|
+
"description": "Maximum buckets in this dimension; upstream default is 10."
|
|
2211
|
+
},
|
|
2212
|
+
"offset": {
|
|
2213
|
+
"type": "integer",
|
|
2214
|
+
"minimum": 0,
|
|
2215
|
+
"maximum": 999,
|
|
2216
|
+
"description": "First-dimension bucket offset; upstream default is 0."
|
|
2217
|
+
}
|
|
2218
|
+
},
|
|
2219
|
+
"additionalProperties": false,
|
|
2220
|
+
"required": [
|
|
2221
|
+
"field",
|
|
2222
|
+
"sort"
|
|
2223
|
+
],
|
|
2224
|
+
"description": "One grouping dimension."
|
|
2225
|
+
},
|
|
2226
|
+
"description": "One to three successive grouping dimensions. Only the first dimension supports offset; size plus offset cannot exceed 1000.",
|
|
2227
|
+
"minItems": 1,
|
|
2228
|
+
"maxItems": 3
|
|
2229
|
+
},
|
|
2230
|
+
"time_series": {
|
|
2231
|
+
"type": "object",
|
|
2232
|
+
"properties": {
|
|
2233
|
+
"interval": {
|
|
2234
|
+
"type": "string",
|
|
2235
|
+
"enum": [
|
|
2236
|
+
"week",
|
|
2237
|
+
"month",
|
|
2238
|
+
"quarter",
|
|
2239
|
+
"year"
|
|
2240
|
+
],
|
|
2241
|
+
"description": "Time-series bucket interval."
|
|
2242
|
+
},
|
|
2243
|
+
"min_date": {
|
|
2244
|
+
"type": "string",
|
|
2245
|
+
"description": "First date included in the time series.",
|
|
2246
|
+
"format": "date"
|
|
2247
|
+
},
|
|
2248
|
+
"max_date": {
|
|
2249
|
+
"type": "string",
|
|
2250
|
+
"description": "Last date included in the time series.",
|
|
2251
|
+
"format": "date"
|
|
2252
|
+
}
|
|
2253
|
+
},
|
|
2254
|
+
"additionalProperties": false,
|
|
2255
|
+
"required": [
|
|
2256
|
+
"interval"
|
|
2257
|
+
],
|
|
2258
|
+
"description": "Time-series aggregation within the rollup."
|
|
2259
|
+
}
|
|
2260
|
+
},
|
|
2261
|
+
"additionalProperties": false,
|
|
2262
|
+
"required": [
|
|
2263
|
+
"data_source",
|
|
2264
|
+
"dimensions"
|
|
2265
|
+
],
|
|
2266
|
+
"description": "Shipment rollup criteria."
|
|
2267
|
+
},
|
|
2268
|
+
"outputSchema": {
|
|
2269
|
+
"type": "object",
|
|
2270
|
+
"properties": {
|
|
2271
|
+
"record_count": {
|
|
2272
|
+
"type": "object",
|
|
2273
|
+
"properties": {
|
|
2274
|
+
"total": {
|
|
2275
|
+
"type": "integer",
|
|
2276
|
+
"description": "Total matching records."
|
|
2277
|
+
},
|
|
2278
|
+
"returned": {
|
|
2279
|
+
"type": "integer",
|
|
2280
|
+
"description": "Records returned in this response."
|
|
2281
|
+
}
|
|
2282
|
+
},
|
|
2283
|
+
"additionalProperties": true,
|
|
2284
|
+
"description": "Matching and returned record counts."
|
|
2285
|
+
},
|
|
2286
|
+
"analytics": {
|
|
2287
|
+
"type": "object",
|
|
2288
|
+
"properties": {},
|
|
2289
|
+
"additionalProperties": true,
|
|
2290
|
+
"description": "Panjiva metrics, refinements, time_series or rollup results, keyed by requested fields."
|
|
2291
|
+
}
|
|
2292
|
+
},
|
|
2293
|
+
"additionalProperties": true,
|
|
2294
|
+
"description": "Matching record counts and requested analytics."
|
|
2295
|
+
}
|
|
2296
|
+
},
|
|
2297
|
+
{
|
|
2298
|
+
"id": "panjiva.search_companies",
|
|
2299
|
+
"service": "panjiva",
|
|
2300
|
+
"name": "search_companies",
|
|
2301
|
+
"description": "Find buyers and suppliers through matching Panjiva trade records, with company identity types and trade-role filtering.",
|
|
2302
|
+
"operationType": "read",
|
|
2303
|
+
"requiredScopes": [],
|
|
2304
|
+
"providerPermissions": [],
|
|
2305
|
+
"inputSchema": {
|
|
2306
|
+
"type": "object",
|
|
2307
|
+
"properties": {
|
|
2308
|
+
"query": {
|
|
2309
|
+
"type": "object",
|
|
2310
|
+
"properties": {
|
|
2311
|
+
"text": {
|
|
2312
|
+
"type": "string",
|
|
2313
|
+
"description": "Search text. Supports + (AND), | (OR), - (exclude), quoted phrases, trailing *, and parentheses."
|
|
2314
|
+
},
|
|
2315
|
+
"group": {
|
|
2316
|
+
"type": "string",
|
|
2317
|
+
"description": "Named search group, such as goods_described, consignee_name, shipper_name, or main. Discover groups with get_data_source_metadata."
|
|
2318
|
+
},
|
|
2319
|
+
"custom_group": {
|
|
2320
|
+
"type": "array",
|
|
2321
|
+
"items": {
|
|
2322
|
+
"type": "string",
|
|
2323
|
+
"description": "Searchable field name."
|
|
2324
|
+
},
|
|
2325
|
+
"description": "Explicit fields to search instead of a named group."
|
|
2326
|
+
},
|
|
2327
|
+
"operator": {
|
|
2328
|
+
"type": "string",
|
|
2329
|
+
"enum": [
|
|
2330
|
+
"AND",
|
|
2331
|
+
"OR"
|
|
2332
|
+
],
|
|
2333
|
+
"description": "Boolean operator between search terms; the upstream default is OR."
|
|
2334
|
+
},
|
|
2335
|
+
"match": {
|
|
2336
|
+
"type": "string",
|
|
2337
|
+
"enum": [
|
|
2338
|
+
"stem",
|
|
2339
|
+
"exact"
|
|
2340
|
+
],
|
|
2341
|
+
"description": "Match word stems or exact terms; the upstream default is stem."
|
|
2342
|
+
}
|
|
2343
|
+
},
|
|
2344
|
+
"additionalProperties": false,
|
|
2345
|
+
"required": [
|
|
2346
|
+
"text"
|
|
2347
|
+
],
|
|
2348
|
+
"description": "Free-text search criteria."
|
|
2349
|
+
},
|
|
2350
|
+
"queries": {
|
|
2351
|
+
"type": "array",
|
|
2352
|
+
"items": {
|
|
2353
|
+
"type": "object",
|
|
2354
|
+
"properties": {
|
|
2355
|
+
"text": {
|
|
2356
|
+
"type": "string",
|
|
2357
|
+
"description": "Search text. Supports + (AND), | (OR), - (exclude), quoted phrases, trailing *, and parentheses."
|
|
2358
|
+
},
|
|
2359
|
+
"group": {
|
|
2360
|
+
"type": "string",
|
|
2361
|
+
"description": "Named search group, such as goods_described, consignee_name, shipper_name, or main. Discover groups with get_data_source_metadata."
|
|
2362
|
+
},
|
|
2363
|
+
"custom_group": {
|
|
2364
|
+
"type": "array",
|
|
2365
|
+
"items": {
|
|
2366
|
+
"type": "string",
|
|
2367
|
+
"description": "Searchable field name."
|
|
2368
|
+
},
|
|
2369
|
+
"description": "Explicit fields to search instead of a named group."
|
|
2370
|
+
},
|
|
2371
|
+
"operator": {
|
|
2372
|
+
"type": "string",
|
|
2373
|
+
"enum": [
|
|
2374
|
+
"AND",
|
|
2375
|
+
"OR"
|
|
2376
|
+
],
|
|
2377
|
+
"description": "Boolean operator between search terms; the upstream default is OR."
|
|
2378
|
+
},
|
|
2379
|
+
"match": {
|
|
2380
|
+
"type": "string",
|
|
2381
|
+
"enum": [
|
|
2382
|
+
"stem",
|
|
2383
|
+
"exact"
|
|
2384
|
+
],
|
|
2385
|
+
"description": "Match word stems or exact terms; the upstream default is stem."
|
|
2386
|
+
}
|
|
2387
|
+
},
|
|
2388
|
+
"additionalProperties": false,
|
|
2389
|
+
"required": [
|
|
2390
|
+
"text"
|
|
2391
|
+
],
|
|
2392
|
+
"description": "Free-text search criteria."
|
|
2393
|
+
},
|
|
2394
|
+
"description": "Multiple search criteria; every query must match.",
|
|
2395
|
+
"maxItems": 500
|
|
2396
|
+
},
|
|
2397
|
+
"filters": {
|
|
2398
|
+
"type": "object",
|
|
2399
|
+
"properties": {},
|
|
2400
|
+
"additionalProperties": true,
|
|
2401
|
+
"description": "Native Panjiva filters, including AND, OR, NOT, ranges, dates and geographic constraints. For example: {record_date:{gte:'2025-01-01'},destination_countries:'United States'}. Discover fields with get_data_source_metadata; syntax: https://panjiva.com/api-guide/data-selection/filters."
|
|
2402
|
+
},
|
|
2403
|
+
"company_type": {
|
|
2404
|
+
"type": "string",
|
|
2405
|
+
"enum": [
|
|
2406
|
+
"ccn",
|
|
2407
|
+
"country_company_name",
|
|
2408
|
+
"pid",
|
|
2409
|
+
"capiq",
|
|
2410
|
+
"ultimate_parent_capiq"
|
|
2411
|
+
],
|
|
2412
|
+
"description": "Company identifier representation; upstream default is country_company_name."
|
|
2413
|
+
},
|
|
2414
|
+
"direction": {
|
|
2415
|
+
"type": "string",
|
|
2416
|
+
"enum": [
|
|
2417
|
+
"bidirectional",
|
|
2418
|
+
"consignee",
|
|
2419
|
+
"shipper"
|
|
2420
|
+
],
|
|
2421
|
+
"description": "Trade role to search; upstream default is bidirectional."
|
|
2422
|
+
},
|
|
2423
|
+
"metrics": {
|
|
2424
|
+
"type": "array",
|
|
2425
|
+
"items": {
|
|
2426
|
+
"type": "object",
|
|
2427
|
+
"properties": {
|
|
2428
|
+
"metric": {
|
|
2429
|
+
"type": "string",
|
|
2430
|
+
"description": "Numeric field to aggregate, such as value_usd, weight_kg or volume_teu. Available fields depend on the data source."
|
|
2431
|
+
},
|
|
2432
|
+
"op": {
|
|
2433
|
+
"type": "string",
|
|
2434
|
+
"enum": [
|
|
2435
|
+
"sum",
|
|
2436
|
+
"max",
|
|
2437
|
+
"avg",
|
|
2438
|
+
"min"
|
|
2439
|
+
],
|
|
2440
|
+
"description": "Statistical aggregation operation."
|
|
2441
|
+
}
|
|
2442
|
+
},
|
|
2443
|
+
"additionalProperties": false,
|
|
2444
|
+
"description": "Metric and aggregation operation."
|
|
2445
|
+
},
|
|
2446
|
+
"description": "Aggregate statistics across matching shipments."
|
|
2447
|
+
},
|
|
2448
|
+
"size": {
|
|
2449
|
+
"type": "integer",
|
|
2450
|
+
"minimum": 0,
|
|
2451
|
+
"maximum": 5000,
|
|
2452
|
+
"description": "Maximum company results per trade direction."
|
|
2453
|
+
},
|
|
2454
|
+
"sort": {
|
|
2455
|
+
"type": "object",
|
|
2456
|
+
"properties": {
|
|
2457
|
+
"key": {
|
|
2458
|
+
"type": "string",
|
|
2459
|
+
"description": "Sort by count, field, or an available metric."
|
|
2460
|
+
},
|
|
2461
|
+
"order": {
|
|
2462
|
+
"type": "string",
|
|
2463
|
+
"enum": [
|
|
2464
|
+
"asc",
|
|
2465
|
+
"desc"
|
|
2466
|
+
],
|
|
2467
|
+
"description": "Ascending or descending order."
|
|
2468
|
+
},
|
|
2469
|
+
"op": {
|
|
2470
|
+
"type": "string",
|
|
2471
|
+
"enum": [
|
|
2472
|
+
"sum",
|
|
2473
|
+
"max",
|
|
2474
|
+
"avg",
|
|
2475
|
+
"min"
|
|
2476
|
+
],
|
|
2477
|
+
"description": "Statistical aggregation operation."
|
|
2478
|
+
}
|
|
2479
|
+
},
|
|
2480
|
+
"additionalProperties": false,
|
|
2481
|
+
"required": [
|
|
2482
|
+
"key"
|
|
2483
|
+
],
|
|
2484
|
+
"description": "Sort an aggregation; metric keys must also be declared in metrics."
|
|
2485
|
+
}
|
|
2486
|
+
},
|
|
2487
|
+
"additionalProperties": false,
|
|
2488
|
+
"description": "Company search criteria."
|
|
2489
|
+
},
|
|
2490
|
+
"outputSchema": {
|
|
2491
|
+
"type": "object",
|
|
2492
|
+
"properties": {
|
|
2493
|
+
"consignees": {
|
|
2494
|
+
"type": "array",
|
|
2495
|
+
"items": {
|
|
2496
|
+
"type": "object",
|
|
2497
|
+
"properties": {},
|
|
2498
|
+
"additionalProperties": true,
|
|
2499
|
+
"description": "Native company entity, trade statistics and requested aggregations."
|
|
2500
|
+
},
|
|
2501
|
+
"description": "Matching buyers or consignees."
|
|
2502
|
+
},
|
|
2503
|
+
"shippers": {
|
|
2504
|
+
"type": "array",
|
|
2505
|
+
"items": {
|
|
2506
|
+
"type": "object",
|
|
2507
|
+
"properties": {},
|
|
2508
|
+
"additionalProperties": true,
|
|
2509
|
+
"description": "Native company entity, trade statistics and requested aggregations."
|
|
2510
|
+
},
|
|
2511
|
+
"description": "Matching suppliers or shippers."
|
|
2512
|
+
}
|
|
2513
|
+
},
|
|
2514
|
+
"additionalProperties": true,
|
|
2515
|
+
"description": "Company results separated by trade role."
|
|
2516
|
+
}
|
|
2517
|
+
},
|
|
2518
|
+
{
|
|
2519
|
+
"id": "panjiva.search_hs_codes",
|
|
2520
|
+
"service": "panjiva",
|
|
2521
|
+
"name": "search_hs_codes",
|
|
2522
|
+
"description": "Search Harmonized System codes and US Harmonized Tariff Schedule descriptions.",
|
|
2523
|
+
"operationType": "read",
|
|
2524
|
+
"requiredScopes": [],
|
|
2525
|
+
"providerPermissions": [],
|
|
2526
|
+
"inputSchema": {
|
|
2527
|
+
"type": "object",
|
|
2528
|
+
"properties": {
|
|
2529
|
+
"query": {
|
|
2530
|
+
"type": "object",
|
|
2531
|
+
"properties": {
|
|
2532
|
+
"text": {
|
|
2533
|
+
"type": "string",
|
|
2534
|
+
"description": "Text to search in HS code descriptions."
|
|
2535
|
+
}
|
|
2536
|
+
},
|
|
2537
|
+
"additionalProperties": false,
|
|
2538
|
+
"description": "HS code text query."
|
|
2539
|
+
},
|
|
2540
|
+
"queries": {
|
|
2541
|
+
"type": "array",
|
|
2542
|
+
"items": {
|
|
2543
|
+
"type": "object",
|
|
2544
|
+
"properties": {
|
|
2545
|
+
"text": {
|
|
2546
|
+
"type": "string",
|
|
2547
|
+
"description": "Text to search in HS code descriptions."
|
|
2548
|
+
}
|
|
2549
|
+
},
|
|
2550
|
+
"additionalProperties": false,
|
|
2551
|
+
"description": "HS code text query."
|
|
2552
|
+
},
|
|
2553
|
+
"description": "Additional HS code text queries."
|
|
2554
|
+
},
|
|
2555
|
+
"filters": {
|
|
2556
|
+
"type": "object",
|
|
2557
|
+
"properties": {},
|
|
2558
|
+
"additionalProperties": true,
|
|
2559
|
+
"description": "HS code level and section constraints, supporting AND, OR and NOT. Levels are 2, 4, 6, 8 or 10."
|
|
2560
|
+
},
|
|
2561
|
+
"offset": {
|
|
2562
|
+
"type": "integer",
|
|
2563
|
+
"minimum": 0,
|
|
2564
|
+
"maximum": 4500,
|
|
2565
|
+
"description": "Record offset."
|
|
2566
|
+
},
|
|
2567
|
+
"size": {
|
|
2568
|
+
"type": "integer",
|
|
2569
|
+
"minimum": 0,
|
|
2570
|
+
"maximum": 500,
|
|
2571
|
+
"description": "Maximum records to return."
|
|
2572
|
+
}
|
|
2573
|
+
},
|
|
2574
|
+
"additionalProperties": false,
|
|
2575
|
+
"required": [
|
|
2576
|
+
"query"
|
|
2577
|
+
],
|
|
2578
|
+
"description": "HS code search criteria."
|
|
2579
|
+
},
|
|
2580
|
+
"outputSchema": {
|
|
2581
|
+
"type": "object",
|
|
2582
|
+
"properties": {
|
|
2583
|
+
"record_count": {
|
|
2584
|
+
"type": "object",
|
|
2585
|
+
"properties": {
|
|
2586
|
+
"total": {
|
|
2587
|
+
"type": "integer",
|
|
2588
|
+
"description": "Total matching records."
|
|
2589
|
+
},
|
|
2590
|
+
"returned": {
|
|
2591
|
+
"type": "integer",
|
|
2592
|
+
"description": "Records returned in this response."
|
|
2593
|
+
}
|
|
2594
|
+
},
|
|
2595
|
+
"additionalProperties": true,
|
|
2596
|
+
"description": "Matching and returned record counts."
|
|
2597
|
+
},
|
|
2598
|
+
"results": {
|
|
2599
|
+
"type": "array",
|
|
2600
|
+
"items": {
|
|
2601
|
+
"type": "object",
|
|
2602
|
+
"properties": {
|
|
2603
|
+
"commodity": {
|
|
2604
|
+
"type": "string",
|
|
2605
|
+
"description": "HS code."
|
|
2606
|
+
},
|
|
2607
|
+
"description": {
|
|
2608
|
+
"type": "string",
|
|
2609
|
+
"description": "Commodity description."
|
|
2610
|
+
},
|
|
2611
|
+
"level": {
|
|
2612
|
+
"type": "string",
|
|
2613
|
+
"description": "HS code digit level."
|
|
2614
|
+
},
|
|
2615
|
+
"parent": {
|
|
2616
|
+
"type": "string",
|
|
2617
|
+
"description": "Parent HS code."
|
|
2618
|
+
},
|
|
2619
|
+
"section": {
|
|
2620
|
+
"type": "string",
|
|
2621
|
+
"description": "HS system section."
|
|
2622
|
+
}
|
|
2623
|
+
},
|
|
2624
|
+
"additionalProperties": true,
|
|
2625
|
+
"description": "HS code and its hierarchy."
|
|
2626
|
+
},
|
|
2627
|
+
"description": "Matching HS codes."
|
|
2628
|
+
},
|
|
2629
|
+
"analytics": {
|
|
2630
|
+
"type": "object",
|
|
2631
|
+
"properties": {},
|
|
2632
|
+
"additionalProperties": true,
|
|
2633
|
+
"description": "Panjiva metrics, refinements, time_series or rollup results, keyed by requested fields."
|
|
2634
|
+
}
|
|
2635
|
+
},
|
|
2636
|
+
"additionalProperties": true,
|
|
2637
|
+
"description": "HS code search results."
|
|
2638
|
+
}
|
|
2639
|
+
},
|
|
2640
|
+
{
|
|
2641
|
+
"id": "panjiva.search_shipments",
|
|
2642
|
+
"service": "panjiva",
|
|
2643
|
+
"name": "search_shipments",
|
|
2644
|
+
"description": "Search Panjiva import and export shipment records with filtering, sorting, pagination and optional metrics. Use bulk_search_shipments for larger result sets.",
|
|
2645
|
+
"operationType": "read",
|
|
2646
|
+
"requiredScopes": [],
|
|
2647
|
+
"providerPermissions": [],
|
|
2648
|
+
"inputSchema": {
|
|
2649
|
+
"type": "object",
|
|
2650
|
+
"properties": {
|
|
2651
|
+
"data_source": {
|
|
2652
|
+
"type": "string",
|
|
2653
|
+
"minLength": 1,
|
|
2654
|
+
"description": "Data source, such as global or us-imports. Use list_data_sources to discover available sources; global covers the last five years."
|
|
2655
|
+
},
|
|
2656
|
+
"query": {
|
|
2657
|
+
"type": "object",
|
|
2658
|
+
"properties": {
|
|
2659
|
+
"text": {
|
|
2660
|
+
"type": "string",
|
|
2661
|
+
"description": "Search text. Supports + (AND), | (OR), - (exclude), quoted phrases, trailing *, and parentheses."
|
|
2662
|
+
},
|
|
2663
|
+
"group": {
|
|
2664
|
+
"type": "string",
|
|
2665
|
+
"description": "Named search group, such as goods_described, consignee_name, shipper_name, or main. Discover groups with get_data_source_metadata."
|
|
2666
|
+
},
|
|
2667
|
+
"custom_group": {
|
|
2668
|
+
"type": "array",
|
|
2669
|
+
"items": {
|
|
2670
|
+
"type": "string",
|
|
2671
|
+
"description": "Searchable field name."
|
|
2672
|
+
},
|
|
2673
|
+
"description": "Explicit fields to search instead of a named group."
|
|
2674
|
+
},
|
|
2675
|
+
"operator": {
|
|
2676
|
+
"type": "string",
|
|
2677
|
+
"enum": [
|
|
2678
|
+
"AND",
|
|
2679
|
+
"OR"
|
|
2680
|
+
],
|
|
2681
|
+
"description": "Boolean operator between search terms; the upstream default is OR."
|
|
2682
|
+
},
|
|
2683
|
+
"match": {
|
|
2684
|
+
"type": "string",
|
|
2685
|
+
"enum": [
|
|
2686
|
+
"stem",
|
|
2687
|
+
"exact"
|
|
2688
|
+
],
|
|
2689
|
+
"description": "Match word stems or exact terms; the upstream default is stem."
|
|
2690
|
+
}
|
|
2691
|
+
},
|
|
2692
|
+
"additionalProperties": false,
|
|
2693
|
+
"required": [
|
|
2694
|
+
"text"
|
|
2695
|
+
],
|
|
2696
|
+
"description": "Free-text search criteria."
|
|
2697
|
+
},
|
|
2698
|
+
"queries": {
|
|
2699
|
+
"type": "array",
|
|
2700
|
+
"items": {
|
|
2701
|
+
"type": "object",
|
|
2702
|
+
"properties": {
|
|
2703
|
+
"text": {
|
|
2704
|
+
"type": "string",
|
|
2705
|
+
"description": "Search text. Supports + (AND), | (OR), - (exclude), quoted phrases, trailing *, and parentheses."
|
|
2706
|
+
},
|
|
2707
|
+
"group": {
|
|
2708
|
+
"type": "string",
|
|
2709
|
+
"description": "Named search group, such as goods_described, consignee_name, shipper_name, or main. Discover groups with get_data_source_metadata."
|
|
2710
|
+
},
|
|
2711
|
+
"custom_group": {
|
|
2712
|
+
"type": "array",
|
|
2713
|
+
"items": {
|
|
2714
|
+
"type": "string",
|
|
2715
|
+
"description": "Searchable field name."
|
|
2716
|
+
},
|
|
2717
|
+
"description": "Explicit fields to search instead of a named group."
|
|
2718
|
+
},
|
|
2719
|
+
"operator": {
|
|
2720
|
+
"type": "string",
|
|
2721
|
+
"enum": [
|
|
2722
|
+
"AND",
|
|
2723
|
+
"OR"
|
|
2724
|
+
],
|
|
2725
|
+
"description": "Boolean operator between search terms; the upstream default is OR."
|
|
2726
|
+
},
|
|
2727
|
+
"match": {
|
|
2728
|
+
"type": "string",
|
|
2729
|
+
"enum": [
|
|
2730
|
+
"stem",
|
|
2731
|
+
"exact"
|
|
2732
|
+
],
|
|
2733
|
+
"description": "Match word stems or exact terms; the upstream default is stem."
|
|
2734
|
+
}
|
|
2735
|
+
},
|
|
2736
|
+
"additionalProperties": false,
|
|
2737
|
+
"required": [
|
|
2738
|
+
"text"
|
|
2739
|
+
],
|
|
2740
|
+
"description": "Free-text search criteria."
|
|
2741
|
+
},
|
|
2742
|
+
"description": "Multiple search criteria; every query must match.",
|
|
2743
|
+
"maxItems": 500
|
|
2744
|
+
},
|
|
2745
|
+
"filters": {
|
|
2746
|
+
"type": "object",
|
|
2747
|
+
"properties": {},
|
|
2748
|
+
"additionalProperties": true,
|
|
2749
|
+
"description": "Native Panjiva filters, including AND, OR, NOT, ranges, dates and geographic constraints. For example: {record_date:{gte:'2025-01-01'},destination_countries:'United States'}. Discover fields with get_data_source_metadata; syntax: https://panjiva.com/api-guide/data-selection/filters."
|
|
2750
|
+
},
|
|
2751
|
+
"offset": {
|
|
2752
|
+
"type": "integer",
|
|
2753
|
+
"minimum": 0,
|
|
2754
|
+
"maximum": 4500,
|
|
2755
|
+
"description": "Record offset."
|
|
2756
|
+
},
|
|
2757
|
+
"size": {
|
|
2758
|
+
"type": "integer",
|
|
2759
|
+
"minimum": 0,
|
|
2760
|
+
"maximum": 500,
|
|
2761
|
+
"description": "Maximum records to return."
|
|
2762
|
+
},
|
|
2763
|
+
"metrics": {
|
|
2764
|
+
"type": "array",
|
|
2765
|
+
"items": {
|
|
2766
|
+
"type": "object",
|
|
2767
|
+
"properties": {
|
|
2768
|
+
"metric": {
|
|
2769
|
+
"type": "string",
|
|
2770
|
+
"description": "Numeric field to aggregate, such as value_usd, weight_kg or volume_teu. Available fields depend on the data source."
|
|
2771
|
+
},
|
|
2772
|
+
"op": {
|
|
2773
|
+
"type": "string",
|
|
2774
|
+
"enum": [
|
|
2775
|
+
"sum",
|
|
2776
|
+
"max",
|
|
2777
|
+
"avg",
|
|
2778
|
+
"min"
|
|
2779
|
+
],
|
|
2780
|
+
"description": "Statistical aggregation operation."
|
|
2781
|
+
}
|
|
2782
|
+
},
|
|
2783
|
+
"additionalProperties": false,
|
|
2784
|
+
"description": "Metric and aggregation operation."
|
|
2785
|
+
},
|
|
2786
|
+
"description": "Aggregate statistics across matching shipments."
|
|
2787
|
+
},
|
|
2788
|
+
"sort": {
|
|
2789
|
+
"type": "array",
|
|
2790
|
+
"items": {
|
|
2791
|
+
"type": "object",
|
|
2792
|
+
"properties": {
|
|
2793
|
+
"field": {
|
|
2794
|
+
"type": "string",
|
|
2795
|
+
"description": "Sortable shipment field; discover fields with get_data_source_metadata."
|
|
2796
|
+
},
|
|
2797
|
+
"order": {
|
|
2798
|
+
"type": "string",
|
|
2799
|
+
"enum": [
|
|
2800
|
+
"asc",
|
|
2801
|
+
"desc"
|
|
2802
|
+
],
|
|
2803
|
+
"description": "Ascending or descending order."
|
|
2804
|
+
}
|
|
2805
|
+
},
|
|
2806
|
+
"additionalProperties": false,
|
|
2807
|
+
"description": "One shipment sort rule."
|
|
2808
|
+
},
|
|
2809
|
+
"description": "Shipment sort fields in priority order."
|
|
2810
|
+
}
|
|
2811
|
+
},
|
|
2812
|
+
"additionalProperties": false,
|
|
2813
|
+
"required": [
|
|
2814
|
+
"data_source"
|
|
2815
|
+
],
|
|
2816
|
+
"description": "Shipment search criteria."
|
|
2817
|
+
},
|
|
2818
|
+
"outputSchema": {
|
|
2819
|
+
"type": "object",
|
|
2820
|
+
"properties": {
|
|
2821
|
+
"record_count": {
|
|
2822
|
+
"type": "object",
|
|
2823
|
+
"properties": {
|
|
2824
|
+
"total": {
|
|
2825
|
+
"type": "integer",
|
|
2826
|
+
"description": "Total matching records."
|
|
2827
|
+
},
|
|
2828
|
+
"returned": {
|
|
2829
|
+
"type": "integer",
|
|
2830
|
+
"description": "Records returned in this response."
|
|
2831
|
+
}
|
|
2832
|
+
},
|
|
2833
|
+
"additionalProperties": true,
|
|
2834
|
+
"description": "Matching and returned record counts."
|
|
2835
|
+
},
|
|
2836
|
+
"records": {
|
|
2837
|
+
"type": "array",
|
|
2838
|
+
"items": {
|
|
2839
|
+
"type": "object",
|
|
2840
|
+
"properties": {},
|
|
2841
|
+
"additionalProperties": true,
|
|
2842
|
+
"description": "Native record with all data-source-specific fields preserved."
|
|
2843
|
+
},
|
|
2844
|
+
"description": "Matching shipment records."
|
|
2845
|
+
},
|
|
2846
|
+
"analytics": {
|
|
2847
|
+
"type": "object",
|
|
2848
|
+
"properties": {},
|
|
2849
|
+
"additionalProperties": true,
|
|
2850
|
+
"description": "Panjiva metrics, refinements, time_series or rollup results, keyed by requested fields."
|
|
2851
|
+
}
|
|
2852
|
+
},
|
|
2853
|
+
"additionalProperties": true,
|
|
2854
|
+
"description": "Shipment search results."
|
|
2855
|
+
}
|
|
2856
|
+
}
|
|
2857
|
+
]
|
|
2858
|
+
}
|