@oneshot-agent/mcp-server 0.35.0 → 0.37.0
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 +19 -19
- package/dist/index.js +1 -1
- package/dist/tools/annotations.js +26 -14
- package/dist/tools/browser.js +1 -1
- package/dist/tools/company.d.ts +4 -4
- package/dist/tools/company.js +8 -8
- package/dist/tools/compute.d.ts +3 -2
- package/dist/tools/compute.js +4 -4
- package/dist/tools/domains.js +1 -1
- package/dist/tools/email.js +2 -2
- package/dist/tools/enrichment.d.ts +6 -6
- package/dist/tools/enrichment.js +12 -12
- package/dist/tools/gov.d.ts +2 -2
- package/dist/tools/gov.js +4 -4
- package/dist/tools/index.js +39 -34
- package/dist/tools/linkedin.js +8 -6
- package/dist/tools/local.d.ts +4 -4
- package/dist/tools/local.js +9 -9
- package/dist/tools/lookup-manifest.generated.d.ts +34 -0
- package/dist/tools/lookup-manifest.generated.js +1458 -0
- package/dist/tools/lookup.d.ts +29 -0
- package/dist/tools/lookup.js +44 -0
- package/dist/tools/nyne.d.ts +11 -11
- package/dist/tools/nyne.js +23 -23
- package/dist/tools/people.d.ts +2 -2
- package/dist/tools/people.js +5 -5
- package/package.json +2 -2
|
@@ -0,0 +1,1458 @@
|
|
|
1
|
+
// Generated by scripts/generate-lookup-tools.ts from the lookup registry. Do not edit by hand;
|
|
2
|
+
// run `bun scripts/generate-lookup-tools.ts` after adding or changing a lookup tool.
|
|
3
|
+
// Plain data on purpose: the published package must not import from apps/.
|
|
4
|
+
export const LOOKUP_MANIFEST = [
|
|
5
|
+
{
|
|
6
|
+
"name": "company_bank_profile",
|
|
7
|
+
"path": "lookup/company-bank-profile",
|
|
8
|
+
"title": "Bank Profile",
|
|
9
|
+
"description": "Given a bank's name or its FDIC certificate number, return the matching institutions insured by the US Federal Deposit Insurance Corporation. Each has its name, certificate number, whether it is currently open and insured, city and state, primary federal regulator, charter class code, the date it was established, its website, and its total assets and total deposits in US dollars as of the reporting date. Use it to check that a bank is real, insured and still open. Give exactly one of `name` and `fdic_certificate`. A name is a text match, so similarly named banks come back too, best match first: tell them apart by the certificate number on each row, and prefer the certificate number when you have it, since it is an exact match. Closed institutions are included, with `active` false. `total` is the number of institutions that matched, which may be more than `limit`. No match is a completed result with `total` 0 and an empty list. Credit unions are not included.",
|
|
10
|
+
"inputSchema": {
|
|
11
|
+
"type": "object",
|
|
12
|
+
"properties": {
|
|
13
|
+
"name": {
|
|
14
|
+
"type": "string",
|
|
15
|
+
"description": "The bank's name, for example Grasshopper Bank. A text match: similarly named banks are returned too. 2 to 100 characters."
|
|
16
|
+
},
|
|
17
|
+
"fdic_certificate": {
|
|
18
|
+
"type": "integer",
|
|
19
|
+
"description": "The FDIC certificate number, for example 59113. An exact match; preferred over a name. At least 1."
|
|
20
|
+
},
|
|
21
|
+
"limit": {
|
|
22
|
+
"type": "integer",
|
|
23
|
+
"description": "Most banks to return. From 1 to 10. Defaults to `5`."
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
"required": []
|
|
27
|
+
},
|
|
28
|
+
"example": {
|
|
29
|
+
"fdic_certificate": 59113
|
|
30
|
+
}
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
"name": "record_clinical_trials_find",
|
|
34
|
+
"path": "find/record-clinical-trials",
|
|
35
|
+
"title": "Clinical Trials",
|
|
36
|
+
"description": "Search the clinical studies registered with the US National Library of Medicine, in any country, for a condition, a treatment or other search words, most recently updated first. Each study gives its registry number, title, status, phases, study type, conditions, interventions, lead sponsor, enrollment, start and primary completion dates, the date it was last updated, the countries of its sites and a link to the study. Give `condition`, `query` or both, and optionally narrow by `status` (recruiting, not_yet_recruiting, active_not_recruiting, completed, terminated, withdrawn or suspended). Use it to see what research is registered on a disease or a drug, who sponsors it and how far along it is. A study record is what the sponsor registered, not a finding about a treatment. Contact and investigator details are not returned. `total` is how many studies matched, including any beyond `limit`, and is 0 when none did.",
|
|
37
|
+
"inputSchema": {
|
|
38
|
+
"type": "object",
|
|
39
|
+
"properties": {
|
|
40
|
+
"condition": {
|
|
41
|
+
"type": "string",
|
|
42
|
+
"description": "A condition or disease, for example psoriasis. 2 to 120 characters."
|
|
43
|
+
},
|
|
44
|
+
"query": {
|
|
45
|
+
"type": "string",
|
|
46
|
+
"description": "A treatment or other search words, for example secukinumab. 2 to 200 characters."
|
|
47
|
+
},
|
|
48
|
+
"status": {
|
|
49
|
+
"type": "string",
|
|
50
|
+
"enum": [
|
|
51
|
+
"recruiting",
|
|
52
|
+
"not_yet_recruiting",
|
|
53
|
+
"active_not_recruiting",
|
|
54
|
+
"completed",
|
|
55
|
+
"terminated",
|
|
56
|
+
"withdrawn",
|
|
57
|
+
"suspended"
|
|
58
|
+
],
|
|
59
|
+
"description": "Only studies with this status"
|
|
60
|
+
},
|
|
61
|
+
"limit": {
|
|
62
|
+
"type": "integer",
|
|
63
|
+
"description": "The most studies to return. From 1 to 20. Defaults to `10`."
|
|
64
|
+
}
|
|
65
|
+
},
|
|
66
|
+
"required": []
|
|
67
|
+
},
|
|
68
|
+
"example": {
|
|
69
|
+
"condition": "psoriasis",
|
|
70
|
+
"query": "secukinumab",
|
|
71
|
+
"status": "recruiting",
|
|
72
|
+
"limit": 1
|
|
73
|
+
}
|
|
74
|
+
},
|
|
75
|
+
{
|
|
76
|
+
"name": "company_filings",
|
|
77
|
+
"path": "lookup/company-filings",
|
|
78
|
+
"title": "Company Filings",
|
|
79
|
+
"description": "Look up a US public company by its Central Index Key (CIK), the identifier the US Securities and Exchange Commission assigns to every filer. Returns the registry record: legal name, entity type, industry, tickers, exchanges, state of incorporation, fiscal year end, website, phone, former names and business address; and the most recent filings, newest first, each with form type, filing date, reporting period and a link to the document. Narrow the filings with `form` (exact form type, for example 10-K), `filed_after` and `filed_before`. Looks up by identifier only: it does not search by company name or ticker, and it does not return officers. Filters apply to the most recent filings the register lists inline (about 1,000), not the full history. `found` is false when the identifier is not in the register.",
|
|
80
|
+
"inputSchema": {
|
|
81
|
+
"type": "object",
|
|
82
|
+
"properties": {
|
|
83
|
+
"cik": {
|
|
84
|
+
"type": "string",
|
|
85
|
+
"description": "The registry identifier (CIK), for example 320193. Shorter numbers are padded with zeros. A CIK is 1 to 10 digits."
|
|
86
|
+
},
|
|
87
|
+
"form": {
|
|
88
|
+
"type": "string",
|
|
89
|
+
"description": "Only filings of this exact form type, for example 10-K. 1 to 20 characters."
|
|
90
|
+
},
|
|
91
|
+
"filed_after": {
|
|
92
|
+
"type": "string",
|
|
93
|
+
"description": "Only filings made on or after this date. Use YYYY-MM-DD."
|
|
94
|
+
},
|
|
95
|
+
"filed_before": {
|
|
96
|
+
"type": "string",
|
|
97
|
+
"description": "Only filings made on or before this date. Use YYYY-MM-DD."
|
|
98
|
+
},
|
|
99
|
+
"limit": {
|
|
100
|
+
"type": "integer",
|
|
101
|
+
"description": "Most filings to return, newest first. From 1 to 50. Defaults to `10`."
|
|
102
|
+
}
|
|
103
|
+
},
|
|
104
|
+
"required": [
|
|
105
|
+
"cik"
|
|
106
|
+
]
|
|
107
|
+
},
|
|
108
|
+
"example": {
|
|
109
|
+
"cik": "320193",
|
|
110
|
+
"form": "8-K",
|
|
111
|
+
"limit": 1
|
|
112
|
+
}
|
|
113
|
+
},
|
|
114
|
+
{
|
|
115
|
+
"name": "company_consumer_complaints",
|
|
116
|
+
"path": "lookup/company-consumer-complaints",
|
|
117
|
+
"title": "Consumer Finance Complaints",
|
|
118
|
+
"description": "Given a financial company's name, return how many complaints consumers have filed about it with the US Consumer Financial Protection Bureau, the five largest groups by product and by how the company answered, and the newest complaints. Use it to check a bank, lender, card issuer or credit bureau before dealing with it. Complaints are consumers' reports, not findings. The source matches the name as text, so similarly named companies can appear: `companies` lists the five most matched names with their counts and every complaint carries the company name the source holds. `since` (YYYY-MM-DD) counts only complaints received on or after that date and `limit` sets how many complaints are returned (1 to 25, default 10). A name with no complaint is a completed result with a total of 0 and empty lists.",
|
|
119
|
+
"inputSchema": {
|
|
120
|
+
"type": "object",
|
|
121
|
+
"properties": {
|
|
122
|
+
"company_name": {
|
|
123
|
+
"type": "string",
|
|
124
|
+
"description": "The financial company's name, for example Wells Fargo. 2 to 100 characters."
|
|
125
|
+
},
|
|
126
|
+
"since": {
|
|
127
|
+
"type": "string",
|
|
128
|
+
"description": "Count only complaints received on or after this date. Use YYYY-MM-DD."
|
|
129
|
+
},
|
|
130
|
+
"limit": {
|
|
131
|
+
"type": "integer",
|
|
132
|
+
"description": "Most complaints to return, newest first. From 1 to 25. Defaults to `10`."
|
|
133
|
+
}
|
|
134
|
+
},
|
|
135
|
+
"required": [
|
|
136
|
+
"company_name"
|
|
137
|
+
]
|
|
138
|
+
},
|
|
139
|
+
"example": {
|
|
140
|
+
"company_name": "Wells Fargo",
|
|
141
|
+
"limit": 1
|
|
142
|
+
}
|
|
143
|
+
},
|
|
144
|
+
{
|
|
145
|
+
"name": "record_court_cases_find",
|
|
146
|
+
"path": "find/record-court-cases",
|
|
147
|
+
"title": "Court Cases",
|
|
148
|
+
"description": "Search a public archive of published US federal and state court opinions, or choose kind=dockets to search federal cases and their filings. Returns case names, courts, filing dates, citations when available, docket numbers, short excerpts and links, ordered by relevance. For opinions, the filing date is the decision date; for dockets, it is when the case was filed. Coverage varies by court and does not include every case or filing. Only the first page is read, with at most limit matches returned. Docket totals above 2,000 are approximate, with up to 6% error. An excerpt is the start of an opinion or a matching filing, at most 500 characters; it is not a case summary. Open the URL for the source record. The source's terms prohibit using this data for credit, insurance, employment, housing or other eligibility decisions covered by the Fair Credit Reporting Act.",
|
|
149
|
+
"inputSchema": {
|
|
150
|
+
"type": "object",
|
|
151
|
+
"properties": {
|
|
152
|
+
"query": {
|
|
153
|
+
"type": "string",
|
|
154
|
+
"description": "Search words, with quotes for an exact phrase and AND, OR or NOT between terms, for example patent. 1 to 500 characters."
|
|
155
|
+
},
|
|
156
|
+
"kind": {
|
|
157
|
+
"type": "string",
|
|
158
|
+
"enum": [
|
|
159
|
+
"opinions",
|
|
160
|
+
"dockets"
|
|
161
|
+
],
|
|
162
|
+
"description": "opinions searches published federal and state decisions; dockets searches federal cases and their filings. Default opinions. Defaults to `\"opinions\"`."
|
|
163
|
+
},
|
|
164
|
+
"court": {
|
|
165
|
+
"type": "string",
|
|
166
|
+
"description": "Only this court, by its short court ID, for example scotus, cafc or txed"
|
|
167
|
+
},
|
|
168
|
+
"filed_after": {
|
|
169
|
+
"type": "string",
|
|
170
|
+
"description": "Only cases filed on or after this date, YYYY-MM-DD; for opinions, this is the decision date"
|
|
171
|
+
},
|
|
172
|
+
"filed_before": {
|
|
173
|
+
"type": "string",
|
|
174
|
+
"description": "Only cases filed on or before this date, YYYY-MM-DD; for opinions, this is the decision date"
|
|
175
|
+
},
|
|
176
|
+
"case_name": {
|
|
177
|
+
"type": "string",
|
|
178
|
+
"description": "Search within case names, for example Merck. 1 to 200 characters."
|
|
179
|
+
},
|
|
180
|
+
"docket_number": {
|
|
181
|
+
"type": "string",
|
|
182
|
+
"description": "Search within docket numbers, for example 23-1027. 1 to 100 characters."
|
|
183
|
+
},
|
|
184
|
+
"limit": {
|
|
185
|
+
"type": "integer",
|
|
186
|
+
"description": "The most matches to return from the first page, from 1 to 20. Default 10. From 1 to 20. Defaults to `10`."
|
|
187
|
+
}
|
|
188
|
+
},
|
|
189
|
+
"required": [
|
|
190
|
+
"query"
|
|
191
|
+
]
|
|
192
|
+
},
|
|
193
|
+
"example": {
|
|
194
|
+
"query": "patent",
|
|
195
|
+
"court": "cafc",
|
|
196
|
+
"case_name": "Merck",
|
|
197
|
+
"docket_number": "23-1027",
|
|
198
|
+
"filed_after": "2025-01-01",
|
|
199
|
+
"filed_before": "2025-12-31",
|
|
200
|
+
"limit": 1
|
|
201
|
+
}
|
|
202
|
+
},
|
|
203
|
+
{
|
|
204
|
+
"name": "place_disasters",
|
|
205
|
+
"path": "lookup/place-disasters",
|
|
206
|
+
"title": "Disaster Declarations",
|
|
207
|
+
"description": "List the federal disaster declarations (floods, hurricanes, fires, storms, earthquakes and more) that covered a US county, newest first. Use it to check the hazard history of a property, a policy or a claim location. Both `state` and `county` are required. Declarations that cover a whole state are included for every county in it and marked `statewide`. `total` is the number of matching declarations, which can exceed the page returned when `limit` is lower. Narrow with `incident_type` (for example Flood, Hurricane, Fire) and a declaration date range. A county with no declarations is a completed result with `total` 0.",
|
|
208
|
+
"inputSchema": {
|
|
209
|
+
"type": "object",
|
|
210
|
+
"properties": {
|
|
211
|
+
"state": {
|
|
212
|
+
"type": "string",
|
|
213
|
+
"description": "State postal code. A state is its two-letter postal code, for example TX."
|
|
214
|
+
},
|
|
215
|
+
"county": {
|
|
216
|
+
"type": "string",
|
|
217
|
+
"description": "County or parish name without the word County or Parish, for example Harris. A county name has 2 to 40 letters, spaces, periods, apostrophes and hyphens, without \"County\" or \"Parish\"."
|
|
218
|
+
},
|
|
219
|
+
"incident_type": {
|
|
220
|
+
"type": "string",
|
|
221
|
+
"description": "Only declarations for this incident type. An incident type is words such as Flood, Hurricane or Fire."
|
|
222
|
+
},
|
|
223
|
+
"declared_after": {
|
|
224
|
+
"type": "string",
|
|
225
|
+
"description": "Only declarations made on or after this date. Use YYYY-MM-DD."
|
|
226
|
+
},
|
|
227
|
+
"declared_before": {
|
|
228
|
+
"type": "string",
|
|
229
|
+
"description": "Only declarations made on or before this date. Use YYYY-MM-DD."
|
|
230
|
+
},
|
|
231
|
+
"limit": {
|
|
232
|
+
"type": "integer",
|
|
233
|
+
"description": "Most declarations to return, newest first. Default 25. From 1 to 100."
|
|
234
|
+
}
|
|
235
|
+
},
|
|
236
|
+
"required": [
|
|
237
|
+
"state",
|
|
238
|
+
"county"
|
|
239
|
+
]
|
|
240
|
+
},
|
|
241
|
+
"example": {
|
|
242
|
+
"state": "TX",
|
|
243
|
+
"county": "Harris",
|
|
244
|
+
"incident_type": "Hurricane",
|
|
245
|
+
"declared_after": "2015-01-01",
|
|
246
|
+
"declared_before": "2024-12-31",
|
|
247
|
+
"limit": 1
|
|
248
|
+
}
|
|
249
|
+
},
|
|
250
|
+
{
|
|
251
|
+
"name": "product_drug_adverse_events",
|
|
252
|
+
"path": "lookup/product-drug-adverse-events",
|
|
253
|
+
"title": "Drug Adverse Events",
|
|
254
|
+
"description": "List the reactions most often named in the adverse event reports sent to the US Food and Drug Administration for a drug, from a drug name matched against the product name on the reports. A name of several words is matched as a phrase. Each reaction is the source's term with the number of reports that name it, most reported first. A drug with no reports gives an empty list. The total number of reports is not given. A report does not show that the drug caused the reaction, the reports are unverified, and the source says its data must not be relied on for decisions about medical care.",
|
|
255
|
+
"inputSchema": {
|
|
256
|
+
"type": "object",
|
|
257
|
+
"properties": {
|
|
258
|
+
"drug_name": {
|
|
259
|
+
"type": "string",
|
|
260
|
+
"description": "The drug's name as it appears on the reports, for example Ozempic or metformin. 2 to 100 characters."
|
|
261
|
+
},
|
|
262
|
+
"limit": {
|
|
263
|
+
"type": "integer",
|
|
264
|
+
"description": "The most reactions to return. From 1 to 25. Defaults to `10`."
|
|
265
|
+
}
|
|
266
|
+
},
|
|
267
|
+
"required": [
|
|
268
|
+
"drug_name"
|
|
269
|
+
]
|
|
270
|
+
},
|
|
271
|
+
"example": {
|
|
272
|
+
"drug_name": "Ozempic",
|
|
273
|
+
"limit": 3
|
|
274
|
+
}
|
|
275
|
+
},
|
|
276
|
+
{
|
|
277
|
+
"name": "product_drug_shortages",
|
|
278
|
+
"path": "lookup/product-drug-shortages",
|
|
279
|
+
"title": "Drug Shortages",
|
|
280
|
+
"description": "Say whether the US Food and Drug Administration lists a drug as in shortage, from a drug name matched against the generic name and the brand name. A name of several words is matched as a phrase. `status` narrows the list to `current` shortages, drugs `to_be_discontinued` or shortages that are `resolved`. Each listed presentation gives the generic name, the brand names, the company, the status, whether it is available, the dosage form, the presentation and its package NDC, the therapeutic categories, the reason it is short, any related information and the dates it was first posted and last updated. Most recently updated first. `total` is how many presentations matched, including any beyond `limit`, and is 0 when the drug is not on the list. A drug that is not listed is not in shortage on this list, which says nothing about a particular pharmacy's stock. The source says its data must not be relied on for decisions about medical care.",
|
|
281
|
+
"inputSchema": {
|
|
282
|
+
"type": "object",
|
|
283
|
+
"properties": {
|
|
284
|
+
"drug_name": {
|
|
285
|
+
"type": "string",
|
|
286
|
+
"description": "The drug's generic or brand name, for example quinapril or sodium chloride. 2 to 100 characters."
|
|
287
|
+
},
|
|
288
|
+
"status": {
|
|
289
|
+
"type": "string",
|
|
290
|
+
"enum": [
|
|
291
|
+
"current",
|
|
292
|
+
"to_be_discontinued",
|
|
293
|
+
"resolved"
|
|
294
|
+
],
|
|
295
|
+
"description": "Only presentations with this status; all statuses when omitted"
|
|
296
|
+
},
|
|
297
|
+
"limit": {
|
|
298
|
+
"type": "integer",
|
|
299
|
+
"description": "The most presentations to return. From 1 to 25. Defaults to `10`."
|
|
300
|
+
}
|
|
301
|
+
},
|
|
302
|
+
"required": [
|
|
303
|
+
"drug_name"
|
|
304
|
+
]
|
|
305
|
+
},
|
|
306
|
+
"example": {
|
|
307
|
+
"drug_name": "quinapril",
|
|
308
|
+
"status": "current",
|
|
309
|
+
"limit": 1
|
|
310
|
+
}
|
|
311
|
+
},
|
|
312
|
+
{
|
|
313
|
+
"name": "product_duty_rate",
|
|
314
|
+
"path": "lookup/product-duty-rate",
|
|
315
|
+
"title": "Duty Rate",
|
|
316
|
+
"description": "Look up lines of the US Harmonized Tariff Schedule with their scheduled rate: the general, special and column 2 (other) rates for a heading such as `7408.11`, or candidate lines for a keyword such as `copper wire`. Lines come in schedule order and keep their `indent`: for a heading lookup every line beneath it is returned, so a line sits under the nearest earlier line with a lower indent; a keyword search returns only the matching lines, without their ancestors, so there `indent` is depth only and says nothing about which heading a line belongs to. A heading has no rate of its own, its rates are on the indented lines below. This is the scheduled rate only: it does not add duties imposed by trade-remedy or emergency actions; footnotes are returned as the schedule gives them, each with the rate column(s) it qualifies, and additional-duties notes as given. It is a lookup, not a classification: it does not choose a code for a product, so a keyword search returns candidates for the caller to choose from. A keyword of several words matches lines containing any of them (`copper wire` returns copper ores as well as wire); wrap the words in double quotes to match the exact phrase (`\"copper wire\"`). Covers goods imported into the US. `total` is how many lines the schedule search matched, as the source counts them; `lines` is cut to `limit`. No match is a completed result with `total` 0.",
|
|
317
|
+
"inputSchema": {
|
|
318
|
+
"type": "object",
|
|
319
|
+
"properties": {
|
|
320
|
+
"query": {
|
|
321
|
+
"type": "string",
|
|
322
|
+
"description": "A tariff heading such as 7408.11, or a keyword such as copper wire. Several words match any of them; wrap them in double quotes for the exact phrase. 2 to 80 characters."
|
|
323
|
+
},
|
|
324
|
+
"limit": {
|
|
325
|
+
"type": "integer",
|
|
326
|
+
"description": "Most lines to return, in schedule order. From 1 to 50. Defaults to `20`."
|
|
327
|
+
}
|
|
328
|
+
},
|
|
329
|
+
"required": [
|
|
330
|
+
"query"
|
|
331
|
+
]
|
|
332
|
+
},
|
|
333
|
+
"example": {
|
|
334
|
+
"query": "7408.11",
|
|
335
|
+
"limit": 2
|
|
336
|
+
}
|
|
337
|
+
},
|
|
338
|
+
{
|
|
339
|
+
"name": "place_earthquakes",
|
|
340
|
+
"path": "lookup/place-earthquakes",
|
|
341
|
+
"title": "Earthquakes",
|
|
342
|
+
"description": "List the earthquakes recorded within a distance of a point, given its latitude and longitude. Use it to check the seismic history around a property, a facility or a route stop. Earthquakes are returned newest first, each with its magnitude, depth in kilometres, how many people reported feeling it (`felt_reports`, null when nobody was asked or none reported) and whether a tsunami was flagged. By default it looks back 30 days within 100 km for magnitude 2.5 and above; `since` and `until` (YYYY-MM-DD, UTC) set the dates, `radius_km` the distance (1 to 500), `min_magnitude` the floor and `limit` the most returned (1 to 50). Events the source records as something other than an earthquake, such as quarry blasts, are left out. A point with no earthquake in range is a completed result with an empty list.",
|
|
343
|
+
"inputSchema": {
|
|
344
|
+
"type": "object",
|
|
345
|
+
"properties": {
|
|
346
|
+
"latitude": {
|
|
347
|
+
"type": "number",
|
|
348
|
+
"description": "Latitude in decimal degrees, for example 37.77. From -90 to 90."
|
|
349
|
+
},
|
|
350
|
+
"longitude": {
|
|
351
|
+
"type": "number",
|
|
352
|
+
"description": "Longitude in decimal degrees (west is negative), for example -122.42. From -180 to 180."
|
|
353
|
+
},
|
|
354
|
+
"radius_km": {
|
|
355
|
+
"type": "number",
|
|
356
|
+
"description": "Distance from the point in kilometres. From 1 to 500. Defaults to `100`."
|
|
357
|
+
},
|
|
358
|
+
"since": {
|
|
359
|
+
"type": "string",
|
|
360
|
+
"description": "Earliest date (UTC); default 30 days before the call. Use YYYY-MM-DD."
|
|
361
|
+
},
|
|
362
|
+
"until": {
|
|
363
|
+
"type": "string",
|
|
364
|
+
"description": "Latest date (UTC); default now. Use YYYY-MM-DD."
|
|
365
|
+
},
|
|
366
|
+
"min_magnitude": {
|
|
367
|
+
"type": "number",
|
|
368
|
+
"description": "Smallest magnitude to return. From 0 to 10. Defaults to `2.5`."
|
|
369
|
+
},
|
|
370
|
+
"limit": {
|
|
371
|
+
"type": "integer",
|
|
372
|
+
"description": "Most earthquakes to return. From 1 to 50. Defaults to `10`."
|
|
373
|
+
}
|
|
374
|
+
},
|
|
375
|
+
"required": [
|
|
376
|
+
"latitude",
|
|
377
|
+
"longitude"
|
|
378
|
+
]
|
|
379
|
+
},
|
|
380
|
+
"example": {
|
|
381
|
+
"latitude": 37.77,
|
|
382
|
+
"longitude": -122.42,
|
|
383
|
+
"radius_km": 100,
|
|
384
|
+
"since": "2026-07-01",
|
|
385
|
+
"min_magnitude": 2.5,
|
|
386
|
+
"limit": 1
|
|
387
|
+
}
|
|
388
|
+
},
|
|
389
|
+
{
|
|
390
|
+
"name": "company_federal_awards",
|
|
391
|
+
"path": "lookup/company-federal-awards",
|
|
392
|
+
"title": "Federal Awards",
|
|
393
|
+
"description": "Look up the US federal contracts or grants held by a recipient, found by its name or its Unique Entity Identifier (UEI), largest first. Give exactly one of `recipient` and `uei`, and `kind` (`contracts` or `grants`): contracts and grants are separate groups and cannot be mixed in one call. Each award has its identifier, recipient name and UEI, total value in US dollars, start and end dates, awarding agency and sub-agency, description and a link to the award record; contracts also carry the industry (NAICS) and product or service (PSC) codes. Searches by date: returns the awards the source lists for the period from `active_after` to `active_before` (default: the last three years up to today; nothing before 2007-10-01). That is not the same as awards running in the period: the source does not limit rows to awards that overlap it, so an award may have ended before the period or start after it. Read each row's start and end dates to judge whether it is current. A name is a text match, so similarly named recipients come back too: tell them apart by the recipient name and UEI on each row, and prefer the UEI when you have it. `has_more` is true when more awards exist than `limit`. No awards is a completed result with an empty list. Covers US federal awards only.",
|
|
394
|
+
"inputSchema": {
|
|
395
|
+
"type": "object",
|
|
396
|
+
"properties": {
|
|
397
|
+
"recipient": {
|
|
398
|
+
"type": "string",
|
|
399
|
+
"description": "Recipient name, for example LOCKHEED MARTIN CORPORATION. A text match: similarly named recipients are returned too. 3 to 120 characters."
|
|
400
|
+
},
|
|
401
|
+
"uei": {
|
|
402
|
+
"type": "string",
|
|
403
|
+
"description": "The recipient's Unique Entity Identifier. Preferred over a name. A UEI is 12 letters and digits."
|
|
404
|
+
},
|
|
405
|
+
"kind": {
|
|
406
|
+
"type": "string",
|
|
407
|
+
"enum": [
|
|
408
|
+
"contracts",
|
|
409
|
+
"grants"
|
|
410
|
+
],
|
|
411
|
+
"description": "Which group of awards to list"
|
|
412
|
+
},
|
|
413
|
+
"active_after": {
|
|
414
|
+
"type": "string",
|
|
415
|
+
"description": "Start of the period to search, not before 2007-10-01. Default: three years before active_before. Use YYYY-MM-DD."
|
|
416
|
+
},
|
|
417
|
+
"active_before": {
|
|
418
|
+
"type": "string",
|
|
419
|
+
"description": "End of the period to search. Default: today. Use YYYY-MM-DD."
|
|
420
|
+
},
|
|
421
|
+
"limit": {
|
|
422
|
+
"type": "integer",
|
|
423
|
+
"description": "Most awards to return, largest first. From 1 to 25. Defaults to `10`."
|
|
424
|
+
}
|
|
425
|
+
},
|
|
426
|
+
"required": [
|
|
427
|
+
"kind"
|
|
428
|
+
]
|
|
429
|
+
},
|
|
430
|
+
"example": {
|
|
431
|
+
"recipient": "LOCKHEED MARTIN CORPORATION",
|
|
432
|
+
"kind": "contracts",
|
|
433
|
+
"limit": 1
|
|
434
|
+
}
|
|
435
|
+
},
|
|
436
|
+
{
|
|
437
|
+
"name": "market_federal_labor_rates",
|
|
438
|
+
"path": "lookup/market-federal-labor-rates",
|
|
439
|
+
"title": "Federal Labor Rates",
|
|
440
|
+
"description": "Look up the ceiling hourly rates that contractors on US federal supply schedule contracts have agreed, matching your words against the labor category, contractor name and contract number (a keyword search, so a match is not always a job title), with the low, middle (median), average and high across every match, and the matching rates with the contractor, contract number, business size, education, years of experience, clearance and worksite. Use it to check whether a quoted hourly rate is in line with what the government pays. These are ceilings, the most the contract allows per hour, not what was paid. Rates are listed lowest first. Covers ceiling hourly rates on US federal supply schedule contracts. `total` is 0 and `summary` is null when nothing matches.",
|
|
441
|
+
"inputSchema": {
|
|
442
|
+
"type": "object",
|
|
443
|
+
"properties": {
|
|
444
|
+
"role": {
|
|
445
|
+
"type": "string",
|
|
446
|
+
"description": "Words to look up, for example software engineer. Matched as a keyword search across labor category, contractor name and contract number, so some rates may not be for that job title. 2 to 80 characters."
|
|
447
|
+
},
|
|
448
|
+
"min_years_experience": {
|
|
449
|
+
"type": "integer",
|
|
450
|
+
"description": "Only rates for roles that ask for at least this many years of experience. From 0 to 45."
|
|
451
|
+
},
|
|
452
|
+
"education": {
|
|
453
|
+
"type": "string",
|
|
454
|
+
"enum": [
|
|
455
|
+
"high_school",
|
|
456
|
+
"associates",
|
|
457
|
+
"bachelors",
|
|
458
|
+
"masters",
|
|
459
|
+
"doctorate"
|
|
460
|
+
],
|
|
461
|
+
"description": "Only rates for roles that ask for exactly this level of education"
|
|
462
|
+
},
|
|
463
|
+
"limit": {
|
|
464
|
+
"type": "integer",
|
|
465
|
+
"description": "The most rates to list. The summary always covers every match. From 1 to 25. Defaults to `10`."
|
|
466
|
+
}
|
|
467
|
+
},
|
|
468
|
+
"required": [
|
|
469
|
+
"role"
|
|
470
|
+
]
|
|
471
|
+
},
|
|
472
|
+
"example": {
|
|
473
|
+
"role": "software engineer",
|
|
474
|
+
"limit": 1
|
|
475
|
+
}
|
|
476
|
+
},
|
|
477
|
+
{
|
|
478
|
+
"name": "record_federal_register_find",
|
|
479
|
+
"path": "find/record-federal-register",
|
|
480
|
+
"title": "Federal Register Documents",
|
|
481
|
+
"description": "Search the US Federal Register, the government's daily journal of rules, proposed rules, notices and presidential documents, for documents that match search words, newest first. Each document gives its document number, title, type, abstract, the date it was published, the agencies that issued it, and links to the document and its PDF. Optionally narrow by `type` (rule, proposed_rule, notice or presidential), by `agency` (the agency's Federal Register slug, for example federal-aviation-administration), and by publication date with `published_after` and `published_before` (YYYY-MM-DD). Use it to find what the government has said or proposed about a subject, a regulation or a company. It covers documents published since 1994 and returns the abstract, not the full text: open the link for that. `total` is how many documents matched, including any beyond `limit`, and is 0 when none did.",
|
|
482
|
+
"inputSchema": {
|
|
483
|
+
"type": "object",
|
|
484
|
+
"properties": {
|
|
485
|
+
"query": {
|
|
486
|
+
"type": "string",
|
|
487
|
+
"description": "Search words, for example drone registration. 2 to 200 characters."
|
|
488
|
+
},
|
|
489
|
+
"type": {
|
|
490
|
+
"type": "string",
|
|
491
|
+
"enum": [
|
|
492
|
+
"rule",
|
|
493
|
+
"proposed_rule",
|
|
494
|
+
"notice",
|
|
495
|
+
"presidential"
|
|
496
|
+
],
|
|
497
|
+
"description": "Only this kind of document"
|
|
498
|
+
},
|
|
499
|
+
"agency": {
|
|
500
|
+
"type": "string",
|
|
501
|
+
"description": "Only documents from this agency, as its Federal Register slug, for example federal-aviation-administration. 2 to 80 characters."
|
|
502
|
+
},
|
|
503
|
+
"published_after": {
|
|
504
|
+
"type": "string",
|
|
505
|
+
"description": "Only documents published on or after this date. Use YYYY-MM-DD."
|
|
506
|
+
},
|
|
507
|
+
"published_before": {
|
|
508
|
+
"type": "string",
|
|
509
|
+
"description": "Only documents published on or before this date. Use YYYY-MM-DD."
|
|
510
|
+
},
|
|
511
|
+
"limit": {
|
|
512
|
+
"type": "integer",
|
|
513
|
+
"description": "The most documents to return. From 1 to 20. Defaults to `10`."
|
|
514
|
+
}
|
|
515
|
+
},
|
|
516
|
+
"required": [
|
|
517
|
+
"query"
|
|
518
|
+
]
|
|
519
|
+
},
|
|
520
|
+
"example": {
|
|
521
|
+
"query": "drone registration",
|
|
522
|
+
"type": "rule",
|
|
523
|
+
"limit": 1
|
|
524
|
+
}
|
|
525
|
+
},
|
|
526
|
+
{
|
|
527
|
+
"name": "place_flood_zone",
|
|
528
|
+
"path": "lookup/place-flood-zone",
|
|
529
|
+
"title": "Flood Zone",
|
|
530
|
+
"description": "Return the flood hazard zone published on the national flood hazard map at a point: the zone, its subtype, whether the point is in a special flood hazard area, the base flood elevation when one is stated, and the map the answer comes from. Give coordinates, not an address; Place Resolve returns the coordinates for an address. Covers US areas with a published flood hazard map. `mapped` is false when no map covers the point. When more than one zone covers the point, the first is returned and `overlapping_zones` gives the count. This is a screening aid, not a flood determination: do not use it as the basis for lending or insurance decisions.",
|
|
531
|
+
"inputSchema": {
|
|
532
|
+
"type": "object",
|
|
533
|
+
"properties": {
|
|
534
|
+
"latitude": {
|
|
535
|
+
"type": "number",
|
|
536
|
+
"description": "Latitude in decimal degrees. From 17 to 72."
|
|
537
|
+
},
|
|
538
|
+
"longitude": {
|
|
539
|
+
"type": "number",
|
|
540
|
+
"description": "Longitude in decimal degrees. From -180 to -64."
|
|
541
|
+
}
|
|
542
|
+
},
|
|
543
|
+
"required": [
|
|
544
|
+
"latitude",
|
|
545
|
+
"longitude"
|
|
546
|
+
]
|
|
547
|
+
},
|
|
548
|
+
"example": {
|
|
549
|
+
"latitude": 29.7604,
|
|
550
|
+
"longitude": -95.3698
|
|
551
|
+
}
|
|
552
|
+
},
|
|
553
|
+
{
|
|
554
|
+
"name": "person_health_provider",
|
|
555
|
+
"path": "lookup/person-health-provider",
|
|
556
|
+
"title": "Health Provider Registration",
|
|
557
|
+
"description": "Look up the national registration of an individual US health care practitioner (a doctor, nurse, pharmacist, therapist and the like) by 10-digit provider number, or by last name and state with optional first name and city. Returns each match with credential, whether the registration is active, specialties with licence state and number, practice address and mailing address, and the date the registry last updated the record. Use it to check that a practitioner in a directory, claim or referral exists and which specialty they are registered under. A registration is not a licence check and not proof that they still practise at the address; judge freshness by `last_updated_on`. Individuals only: organisations are not covered. `total` is the number of providers returned, at most `limit`; no match is `total: 0`.",
|
|
558
|
+
"inputSchema": {
|
|
559
|
+
"type": "object",
|
|
560
|
+
"properties": {
|
|
561
|
+
"npi": {
|
|
562
|
+
"type": "string",
|
|
563
|
+
"description": "The health provider number. Give this, or a last name and state, never both. A health provider number is exactly 10 digits."
|
|
564
|
+
},
|
|
565
|
+
"last_name": {
|
|
566
|
+
"type": "string",
|
|
567
|
+
"description": "Last name of the practitioner. Needs state. 1 to 100 characters."
|
|
568
|
+
},
|
|
569
|
+
"state": {
|
|
570
|
+
"type": "string",
|
|
571
|
+
"description": "US state code. Needs last name. A state is two capital letters, such as TX."
|
|
572
|
+
},
|
|
573
|
+
"first_name": {
|
|
574
|
+
"type": "string",
|
|
575
|
+
"description": "First name of the practitioner, to narrow a name search. 1 to 100 characters."
|
|
576
|
+
},
|
|
577
|
+
"city": {
|
|
578
|
+
"type": "string",
|
|
579
|
+
"description": "A city, to narrow a name search. 1 to 100 characters."
|
|
580
|
+
},
|
|
581
|
+
"limit": {
|
|
582
|
+
"type": "integer",
|
|
583
|
+
"description": "Most providers to return from a name search. From 1 to 20. Defaults to `5`."
|
|
584
|
+
}
|
|
585
|
+
},
|
|
586
|
+
"required": []
|
|
587
|
+
},
|
|
588
|
+
"example": {
|
|
589
|
+
"npi": "1245319599"
|
|
590
|
+
}
|
|
591
|
+
},
|
|
592
|
+
{
|
|
593
|
+
"name": "place_hospitals",
|
|
594
|
+
"path": "lookup/place-hospitals",
|
|
595
|
+
"title": "Hospitals",
|
|
596
|
+
"description": "List the hospitals registered with Medicare in a US ZIP code, from the hospital list of the US Centers for Medicare & Medicaid Services. Each hospital has its name, address, county, published main telephone line, type, ownership, whether it has emergency services and its overall quality rating from 1 to 5. The rating is null when the source gives no number for the hospital. A ZIP code with no registered hospital gives a total of 0 and an empty list. The total is the number of hospitals in the ZIP code, which can be more than the number returned.",
|
|
597
|
+
"inputSchema": {
|
|
598
|
+
"type": "object",
|
|
599
|
+
"properties": {
|
|
600
|
+
"zip_code": {
|
|
601
|
+
"type": "string",
|
|
602
|
+
"description": "A US ZIP code, for example 45220. zip_code must be five digits."
|
|
603
|
+
},
|
|
604
|
+
"limit": {
|
|
605
|
+
"type": "integer",
|
|
606
|
+
"description": "The most hospitals to return. From 1 to 25. Defaults to `10`."
|
|
607
|
+
}
|
|
608
|
+
},
|
|
609
|
+
"required": [
|
|
610
|
+
"zip_code"
|
|
611
|
+
]
|
|
612
|
+
},
|
|
613
|
+
"example": {
|
|
614
|
+
"zip_code": "45220",
|
|
615
|
+
"limit": 2
|
|
616
|
+
}
|
|
617
|
+
},
|
|
618
|
+
{
|
|
619
|
+
"name": "company_legal_identifier",
|
|
620
|
+
"path": "lookup/company-legal-identifier",
|
|
621
|
+
"title": "Legal Entity Identifier",
|
|
622
|
+
"description": "Look up registered legal entities by a company's legal name or by its 20-character Legal Entity Identifier. Give exactly one of `name` and `lei`. Each entity has its identifier, legal name and other names, entity status, jurisdiction, legal form code, registration number, creation date, the identifier's registration status, registration, last update and next renewal dates, how well the record is corroborated, and its legal and headquarters addresses. It answers whether this is the legal entity you think it is, and whether its registration is current. A name is a text match, so similarly named entities come back too: tell them apart by the identifier on each row, and prefer the identifier when you have it, since it is an exact match. `total` is the number of entities that matched, which may be more than `limit`. No match is a completed result with `total` 0 and an empty list. Covers legal entities that hold an identifier; parent and child relationships are not included.",
|
|
623
|
+
"inputSchema": {
|
|
624
|
+
"type": "object",
|
|
625
|
+
"properties": {
|
|
626
|
+
"lei": {
|
|
627
|
+
"type": "string",
|
|
628
|
+
"description": "The Legal Entity Identifier, for example DPRBOZP0K5RM2YE8UU08. An exact match; preferred over a name. A Legal Entity Identifier is 20 letters and digits."
|
|
629
|
+
},
|
|
630
|
+
"name": {
|
|
631
|
+
"type": "string",
|
|
632
|
+
"description": "Legal name, for example Lockheed Martin Corporation. A text match: similarly named entities are returned too. 2 to 200 characters."
|
|
633
|
+
},
|
|
634
|
+
"limit": {
|
|
635
|
+
"type": "integer",
|
|
636
|
+
"description": "Most entities to return. From 1 to 10. Defaults to `5`."
|
|
637
|
+
}
|
|
638
|
+
},
|
|
639
|
+
"required": []
|
|
640
|
+
},
|
|
641
|
+
"example": {
|
|
642
|
+
"lei": "DPRBOZP0K5RM2YE8UU08"
|
|
643
|
+
}
|
|
644
|
+
},
|
|
645
|
+
{
|
|
646
|
+
"name": "company_motor_carrier",
|
|
647
|
+
"path": "lookup/company-motor-carrier",
|
|
648
|
+
"title": "Motor Carrier Record",
|
|
649
|
+
"description": "Given a US Department of Transportation (DOT) number or a motor carrier (MC) number, return the carrier's registration record from the US Department of Transportation: legal and trading name, whether it is active, legal form, physical address, telephone number, kind of operation, the classes of operation and the cargo it registered, its power units and drivers, its reported annual mileage, whether it carries hazardous materials, its safety rating with the date, its latest review date and the date it last updated its registration. Give exactly one of `dot_number` and `mc_number`. A DOT number finds one carrier; an MC number can find more than one, so check `status`. Dates are YYYY-MM-DD and a value the source does not give is null. `total` is the number of carriers returned, at most 5; no match is a completed result with `total` 0 and an empty list. It does not cover operating authority, insurance on file, out-of-service rates or crash counts.",
|
|
650
|
+
"inputSchema": {
|
|
651
|
+
"type": "object",
|
|
652
|
+
"properties": {
|
|
653
|
+
"dot_number": {
|
|
654
|
+
"type": "string",
|
|
655
|
+
"description": "The carrier's US Department of Transportation number, for example 44110. dot_number must be 1 to 8 digits."
|
|
656
|
+
},
|
|
657
|
+
"mc_number": {
|
|
658
|
+
"type": "string",
|
|
659
|
+
"description": "The carrier's motor carrier (MC) number, for example MC-1515. mc_number must be 1 to 8 digits, with an optional MC or MC- in front."
|
|
660
|
+
}
|
|
661
|
+
},
|
|
662
|
+
"required": []
|
|
663
|
+
},
|
|
664
|
+
"example": {
|
|
665
|
+
"dot_number": "44110"
|
|
666
|
+
}
|
|
667
|
+
},
|
|
668
|
+
{
|
|
669
|
+
"name": "place_resolve",
|
|
670
|
+
"path": "resolve/place",
|
|
671
|
+
"title": "Place Resolve",
|
|
672
|
+
"description": "Resolve a US street address to the matched address, its latitude and longitude, and the codes for its state, county and census tract (plus census block and incorporated place when the source has them). Use it first when another fact about a place is keyed by state and county, or by coordinates, so an agent does not have to guess them. Street addresses in the United States only: no post-office boxes, no place names or landmarks, no addresses outside the US. Give the whole address on one line, for example \"1600 Pennsylvania Ave NW, Washington, DC\". Only the best match is returned; `candidates` is how many matches the source offered. An address that matches nothing is a completed result with `found` false and every other field null.",
|
|
673
|
+
"inputSchema": {
|
|
674
|
+
"type": "object",
|
|
675
|
+
"properties": {
|
|
676
|
+
"address": {
|
|
677
|
+
"type": "string",
|
|
678
|
+
"description": "A US street address on one line, with city and state or ZIP, for example 1600 Pennsylvania Ave NW, Washington, DC. 5 to 200 characters."
|
|
679
|
+
}
|
|
680
|
+
},
|
|
681
|
+
"required": [
|
|
682
|
+
"address"
|
|
683
|
+
]
|
|
684
|
+
},
|
|
685
|
+
"example": {
|
|
686
|
+
"address": "1600 Pennsylvania Ave NW, Washington, DC"
|
|
687
|
+
}
|
|
688
|
+
},
|
|
689
|
+
{
|
|
690
|
+
"name": "product_recalls",
|
|
691
|
+
"path": "lookup/product-recalls",
|
|
692
|
+
"title": "Product Recalls",
|
|
693
|
+
"description": "List the recalls of US products that match a product name, a manufacturer or, for consumer products, words from a recall title, optionally within a date range. `category` is required and picks the regulator: `consumer` is consumer products (appliances, tools, toys, furniture, ladders, bicycles, children's products and the like) from the US Consumer Product Safety Commission; `food`, `drug` and `device` are food, drugs and medical devices from the US Food and Drug Administration's enforcement reports, where `classification` (Class I, II or III) narrows the list. Vehicles are Vehicle Recalls. Each recall gives the recall number, the date it was announced and last published, what was recalled, the models and units, the hazard or reason, and the manufacturer or recalling firm. Consumer recalls also give the title, injuries, remedies, retailers and a link to the notice; food, drug and device recalls give the status, the class and where it was distributed. Newest first. Use it to check a product before a purchase, a resale, a claim or a listing. A recall says what was recalled, not whether a particular unit has been repaired. Give at least one of `product_name`, `title` and `manufacturer`; dates alone are refused. `title` is for consumer only. `total` is how many recalls matched, including any beyond `limit`, and is 0 when none did.",
|
|
694
|
+
"inputSchema": {
|
|
695
|
+
"type": "object",
|
|
696
|
+
"properties": {
|
|
697
|
+
"category": {
|
|
698
|
+
"type": "string",
|
|
699
|
+
"enum": [
|
|
700
|
+
"consumer",
|
|
701
|
+
"food",
|
|
702
|
+
"drug",
|
|
703
|
+
"device"
|
|
704
|
+
],
|
|
705
|
+
"description": "Which products and which regulator: consumer (Consumer Product Safety Commission), or food, drug or device (Food and Drug Administration)"
|
|
706
|
+
},
|
|
707
|
+
"product_name": {
|
|
708
|
+
"type": "string",
|
|
709
|
+
"description": "Words from the product name, for example attic stairway. For food, drug and device: letters, digits, spaces and . , ' & - only. 2 to 80 characters."
|
|
710
|
+
},
|
|
711
|
+
"title": {
|
|
712
|
+
"type": "string",
|
|
713
|
+
"description": "Words from the recall title, for example ladder. Category consumer only. 2 to 80 characters."
|
|
714
|
+
},
|
|
715
|
+
"manufacturer": {
|
|
716
|
+
"type": "string",
|
|
717
|
+
"description": "The manufacturer, importer, distributor or retailer, for example Louisville Ladder. For food, drug and device it is the recalling firm: letters, digits, spaces and . , ' & - only. 2 to 80 characters."
|
|
718
|
+
},
|
|
719
|
+
"classification": {
|
|
720
|
+
"type": "string",
|
|
721
|
+
"enum": [
|
|
722
|
+
"Class I",
|
|
723
|
+
"Class II",
|
|
724
|
+
"Class III"
|
|
725
|
+
],
|
|
726
|
+
"description": "Only recalls of this class. Categories food, drug and device only"
|
|
727
|
+
},
|
|
728
|
+
"recalled_after": {
|
|
729
|
+
"type": "string",
|
|
730
|
+
"description": "Only recalls announced on or after this date. Needs a product name, title or manufacturer. Use YYYY-MM-DD."
|
|
731
|
+
},
|
|
732
|
+
"recalled_before": {
|
|
733
|
+
"type": "string",
|
|
734
|
+
"description": "Only recalls announced on or before this date. Needs a product name, title or manufacturer. Use YYYY-MM-DD."
|
|
735
|
+
},
|
|
736
|
+
"limit": {
|
|
737
|
+
"type": "integer",
|
|
738
|
+
"description": "The most recalls to return. From 1 to 25. Defaults to `10`."
|
|
739
|
+
}
|
|
740
|
+
},
|
|
741
|
+
"required": [
|
|
742
|
+
"category"
|
|
743
|
+
]
|
|
744
|
+
},
|
|
745
|
+
"example": {
|
|
746
|
+
"category": "consumer",
|
|
747
|
+
"product_name": "attic stairway",
|
|
748
|
+
"limit": 10
|
|
749
|
+
}
|
|
750
|
+
},
|
|
751
|
+
{
|
|
752
|
+
"name": "company_vat_registration",
|
|
753
|
+
"path": "lookup/company-vat-registration",
|
|
754
|
+
"title": "VAT Registration",
|
|
755
|
+
"description": "Check whether a VAT number is registered today for cross-border trade in an EU member state or Northern Ireland. Give `country`, the two-letter code the source uses (`EL` for Greece, `XI` for Northern Ireland), and `vat_number`; spaces, dots and dashes are removed, and a leading country code equal to `country` is removed. `registered` is true when the number is registered and false when the source says it is not. The registered name and address come back where the member state gives them; some confirm a number and withhold both, which is `null` here. `checked_at` is when the source made the check. A number that is not registered is a completed result. When a member state's own service does not answer or is too busy, the call fails and is never reported as not registered. It confirms registration, not who owns or controls the company.",
|
|
756
|
+
"inputSchema": {
|
|
757
|
+
"type": "object",
|
|
758
|
+
"properties": {
|
|
759
|
+
"country": {
|
|
760
|
+
"type": "string",
|
|
761
|
+
"enum": [
|
|
762
|
+
"AT",
|
|
763
|
+
"BE",
|
|
764
|
+
"BG",
|
|
765
|
+
"CY",
|
|
766
|
+
"CZ",
|
|
767
|
+
"DE",
|
|
768
|
+
"DK",
|
|
769
|
+
"EE",
|
|
770
|
+
"EL",
|
|
771
|
+
"ES",
|
|
772
|
+
"FI",
|
|
773
|
+
"FR",
|
|
774
|
+
"HR",
|
|
775
|
+
"HU",
|
|
776
|
+
"IE",
|
|
777
|
+
"IT",
|
|
778
|
+
"LT",
|
|
779
|
+
"LU",
|
|
780
|
+
"LV",
|
|
781
|
+
"MT",
|
|
782
|
+
"NL",
|
|
783
|
+
"PL",
|
|
784
|
+
"PT",
|
|
785
|
+
"RO",
|
|
786
|
+
"SE",
|
|
787
|
+
"SI",
|
|
788
|
+
"SK",
|
|
789
|
+
"XI"
|
|
790
|
+
],
|
|
791
|
+
"description": "Two-letter code the source uses: the 27 EU member states (EL for Greece) or XI for Northern Ireland"
|
|
792
|
+
},
|
|
793
|
+
"vat_number": {
|
|
794
|
+
"type": "string",
|
|
795
|
+
"description": "The VAT number, 2 to 14 letters and digits once spaces, dots and dashes are removed; a leading country code equal to country is removed. 2 to 40 characters. letters, digits, spaces, dots and dashes only."
|
|
796
|
+
}
|
|
797
|
+
},
|
|
798
|
+
"required": [
|
|
799
|
+
"country",
|
|
800
|
+
"vat_number"
|
|
801
|
+
]
|
|
802
|
+
},
|
|
803
|
+
"example": {
|
|
804
|
+
"country": "IE",
|
|
805
|
+
"vat_number": "6388047V"
|
|
806
|
+
}
|
|
807
|
+
},
|
|
808
|
+
{
|
|
809
|
+
"name": "vehicle_complaints",
|
|
810
|
+
"path": "lookup/vehicle-complaints",
|
|
811
|
+
"title": "Vehicle Complaints",
|
|
812
|
+
"description": "Summarize what owners have reported to the US safety regulator about a vehicle by make, model and model year: how many complaints there are, how many involved a crash, a fire, injuries or deaths, which components are reported most, and the newest complaints with their dates, components and the owner's own words. Use it to check a used vehicle before a purchase, a loan, a claim or a fleet decision. Covers vehicles sold in the United States. Complaints are reports by owners, not findings by the regulator. A complaint does not show that the vehicle has a defect, and a model with few complaints is not proven free of one. To see the safety recalls instead, use Vehicle Recalls. `total` is 0 when the model has no complaints.",
|
|
813
|
+
"inputSchema": {
|
|
814
|
+
"type": "object",
|
|
815
|
+
"properties": {
|
|
816
|
+
"make": {
|
|
817
|
+
"type": "string",
|
|
818
|
+
"description": "The vehicle make, for example Honda. 2 to 40 characters. Letters, digits, spaces and hyphens only."
|
|
819
|
+
},
|
|
820
|
+
"model": {
|
|
821
|
+
"type": "string",
|
|
822
|
+
"description": "The vehicle model, for example CR-V. 1 to 60 characters. Letters, digits, spaces, periods and hyphens only."
|
|
823
|
+
},
|
|
824
|
+
"model_year": {
|
|
825
|
+
"type": "integer",
|
|
826
|
+
"description": "The model year. At least 1950. Model year cannot be later than next year."
|
|
827
|
+
},
|
|
828
|
+
"limit": {
|
|
829
|
+
"type": "integer",
|
|
830
|
+
"description": "The most complaints to return, newest first. From 1 to 25. Defaults to `10`."
|
|
831
|
+
}
|
|
832
|
+
},
|
|
833
|
+
"required": [
|
|
834
|
+
"make",
|
|
835
|
+
"model",
|
|
836
|
+
"model_year"
|
|
837
|
+
]
|
|
838
|
+
},
|
|
839
|
+
"example": {
|
|
840
|
+
"make": "Fiat",
|
|
841
|
+
"model": "124 Spider",
|
|
842
|
+
"model_year": 2019,
|
|
843
|
+
"limit": 1
|
|
844
|
+
}
|
|
845
|
+
},
|
|
846
|
+
{
|
|
847
|
+
"name": "vehicle_identification",
|
|
848
|
+
"path": "lookup/vehicle-identification",
|
|
849
|
+
"title": "Vehicle Identification",
|
|
850
|
+
"description": "Decode a 17-character vehicle identification number (VIN) into the vehicle it names: make, model, model year, trim, body class, engine, fuel, transmission, manufacturer and assembly plant. Use it to confirm that a vehicle in a listing, title, claim or invoice is what it says it is. Covers vehicles sold in the United States. `decoded` is false when the number does not resolve to a vehicle; `notes` then says why.",
|
|
851
|
+
"inputSchema": {
|
|
852
|
+
"type": "object",
|
|
853
|
+
"properties": {
|
|
854
|
+
"vin": {
|
|
855
|
+
"type": "string",
|
|
856
|
+
"description": "The vehicle identification number. A VIN is 17 characters: digits and capital letters, never I, O or Q."
|
|
857
|
+
},
|
|
858
|
+
"model_year": {
|
|
859
|
+
"type": "integer",
|
|
860
|
+
"description": "Model year, when known. Resolves the year for numbers where position 10 is ambiguous. From 1981 to 2100."
|
|
861
|
+
}
|
|
862
|
+
},
|
|
863
|
+
"required": [
|
|
864
|
+
"vin"
|
|
865
|
+
]
|
|
866
|
+
},
|
|
867
|
+
"example": {
|
|
868
|
+
"vin": "1HGCM82633A004352"
|
|
869
|
+
}
|
|
870
|
+
},
|
|
871
|
+
{
|
|
872
|
+
"name": "vehicle_recalls",
|
|
873
|
+
"path": "lookup/vehicle-recalls",
|
|
874
|
+
"title": "Vehicle Recalls",
|
|
875
|
+
"description": "List the safety recalls issued for a vehicle by make, model and model year: the campaign number, the date it was reported, the affected component, what is wrong, the risk, the remedy and whether the owner is told to park the vehicle. Use it to check a used vehicle before a purchase, a loan, a claim or a fleet decision. Covers vehicles sold in the United States. These are the recalls issued for the model. The result does not say whether a particular vehicle has had the repair done. To start from a vehicle identification number, decode it first with Vehicle Identification, which returns the make, model and year. `total` is 0 when the model has no recalls.",
|
|
876
|
+
"inputSchema": {
|
|
877
|
+
"type": "object",
|
|
878
|
+
"properties": {
|
|
879
|
+
"make": {
|
|
880
|
+
"type": "string",
|
|
881
|
+
"description": "The vehicle make, for example Honda. 2 to 40 characters. Letters, digits, spaces and hyphens only."
|
|
882
|
+
},
|
|
883
|
+
"model": {
|
|
884
|
+
"type": "string",
|
|
885
|
+
"description": "The vehicle model, for example CR-V. 1 to 60 characters. Letters, digits, spaces, periods and hyphens only."
|
|
886
|
+
},
|
|
887
|
+
"model_year": {
|
|
888
|
+
"type": "integer",
|
|
889
|
+
"description": "The model year. At least 1950. Model year cannot be later than next year."
|
|
890
|
+
},
|
|
891
|
+
"limit": {
|
|
892
|
+
"type": "integer",
|
|
893
|
+
"description": "The most recalls to return. From 1 to 50. Defaults to `25`."
|
|
894
|
+
}
|
|
895
|
+
},
|
|
896
|
+
"required": [
|
|
897
|
+
"make",
|
|
898
|
+
"model",
|
|
899
|
+
"model_year"
|
|
900
|
+
]
|
|
901
|
+
},
|
|
902
|
+
"example": {
|
|
903
|
+
"make": "Honda",
|
|
904
|
+
"model": "CR-V",
|
|
905
|
+
"model_year": 2019,
|
|
906
|
+
"limit": 1
|
|
907
|
+
}
|
|
908
|
+
},
|
|
909
|
+
{
|
|
910
|
+
"name": "record_vulnerability",
|
|
911
|
+
"path": "lookup/record-vulnerability",
|
|
912
|
+
"title": "Vulnerability",
|
|
913
|
+
"description": "Look up a software vulnerability by its CVE identifier in the US National Vulnerability Database. The record gives a description in English, when it was published and last modified, its analysis status, its severity (the newest CVSS version that has a primary score, with the score, the rating word and the vector), the weakness types, whether it is on the US list of known exploited vulnerabilities (with the date added, the date action is due and the required action), the first 10 references with their tags and a link to the record. The lists of affected product versions are not returned. A record is what the database publishes, not a measure of the risk to any one system. `total` is 1, or 0 when the database has no such identifier. Times are UTC. This product uses the NVD API but is not endorsed or certified by the NVD.",
|
|
914
|
+
"inputSchema": {
|
|
915
|
+
"type": "object",
|
|
916
|
+
"properties": {
|
|
917
|
+
"cve_id": {
|
|
918
|
+
"type": "string",
|
|
919
|
+
"description": "The CVE identifier, for example CVE-2021-44228. Lower case is accepted. A CVE identifier is CVE-, a four-digit year, a dash and four or more digits."
|
|
920
|
+
}
|
|
921
|
+
},
|
|
922
|
+
"required": [
|
|
923
|
+
"cve_id"
|
|
924
|
+
]
|
|
925
|
+
},
|
|
926
|
+
"example": {
|
|
927
|
+
"cve_id": "CVE-2021-44228"
|
|
928
|
+
}
|
|
929
|
+
},
|
|
930
|
+
{
|
|
931
|
+
"name": "place_weather_alerts",
|
|
932
|
+
"path": "lookup/place-weather-alerts",
|
|
933
|
+
"title": "Weather Alerts",
|
|
934
|
+
"description": "List the weather watches, warnings and advisories in force now at a point in the United States, given its latitude and longitude. Use it to check whether a storm, flood, heat, fire-weather or winter-weather alert covers a property, a route stop or a claim location today. Alerts are ordered most severe first (Extreme, Severe, Moderate, Minor, Unknown), then by soonest to expire. The source's active list is returned as it gives it: an alert already issued whose event has not begun (a watch for tomorrow, urgency Future, `onset_at` in the future) is included, so check `urgency` and `onset_at` to tell what is under way from what is coming. `total` is the number of alerts returned. Expired and past alerts are not returned. A point with nothing active is a completed result with `total` 0.",
|
|
935
|
+
"inputSchema": {
|
|
936
|
+
"type": "object",
|
|
937
|
+
"properties": {
|
|
938
|
+
"latitude": {
|
|
939
|
+
"type": "number",
|
|
940
|
+
"description": "Latitude in decimal degrees, for example 29.7604. From 17 to 72."
|
|
941
|
+
},
|
|
942
|
+
"longitude": {
|
|
943
|
+
"type": "number",
|
|
944
|
+
"description": "Longitude in decimal degrees (west is negative), for example -95.3698. From -180 to -64."
|
|
945
|
+
}
|
|
946
|
+
},
|
|
947
|
+
"required": [
|
|
948
|
+
"latitude",
|
|
949
|
+
"longitude"
|
|
950
|
+
]
|
|
951
|
+
},
|
|
952
|
+
"example": {
|
|
953
|
+
"latitude": 30.1487,
|
|
954
|
+
"longitude": -94.0188
|
|
955
|
+
}
|
|
956
|
+
},
|
|
957
|
+
{
|
|
958
|
+
"name": "place_wildfires",
|
|
959
|
+
"path": "lookup/place-wildfires",
|
|
960
|
+
"title": "Wildfires",
|
|
961
|
+
"description": "List the wildfires currently burning within a distance of a point, given its latitude and longitude. Use it to check fire activity around a property, a facility or a route stop. Fires are returned largest first, each with its name, size in acres, the percent contained (null when the source states none), the date it was discovered (YYYY-MM-DD, UTC), and its state and county. `radius_km` sets the distance (1 to 200, default 50) and `limit` the most returned (1 to 25, default 10); `more` is true when the source held more fires in range than were returned. Covers current wildfire perimeters in the United States. A point with no fire in range is a completed result with an empty list; that means no published perimeter matched, not that no fire is near: a new fire may not have a perimeter yet.",
|
|
962
|
+
"inputSchema": {
|
|
963
|
+
"type": "object",
|
|
964
|
+
"properties": {
|
|
965
|
+
"latitude": {
|
|
966
|
+
"type": "number",
|
|
967
|
+
"description": "Latitude in decimal degrees, for example 44.7. From -90 to 90."
|
|
968
|
+
},
|
|
969
|
+
"longitude": {
|
|
970
|
+
"type": "number",
|
|
971
|
+
"description": "Longitude in decimal degrees (west is negative), for example -120.0. From -180 to 180."
|
|
972
|
+
},
|
|
973
|
+
"radius_km": {
|
|
974
|
+
"type": "number",
|
|
975
|
+
"description": "Distance from the point in kilometres. From 1 to 200. Defaults to `50`."
|
|
976
|
+
},
|
|
977
|
+
"limit": {
|
|
978
|
+
"type": "integer",
|
|
979
|
+
"description": "Most fires to return. From 1 to 25. Defaults to `10`."
|
|
980
|
+
}
|
|
981
|
+
},
|
|
982
|
+
"required": [
|
|
983
|
+
"latitude",
|
|
984
|
+
"longitude"
|
|
985
|
+
]
|
|
986
|
+
},
|
|
987
|
+
"example": {
|
|
988
|
+
"latitude": 44.7,
|
|
989
|
+
"longitude": -120,
|
|
990
|
+
"radius_km": 100,
|
|
991
|
+
"limit": 1
|
|
992
|
+
}
|
|
993
|
+
}
|
|
994
|
+
];
|
|
995
|
+
export const ROUTE_MANIFEST = [
|
|
996
|
+
{
|
|
997
|
+
"name": "benchmark",
|
|
998
|
+
"method": "POST",
|
|
999
|
+
"path": "/v1/tools/benchmark",
|
|
1000
|
+
"paid": true,
|
|
1001
|
+
"readOnly": true,
|
|
1002
|
+
"title": "Benchmark",
|
|
1003
|
+
"description": "Where a value sits among its peers: the distribution of a numeric field over a peer set (count, minimum, quartiles, median, maximum) and the percentile of one entity or value in it. Give `attribute`, `field`, and the filters `peers` that define the set. A peer set under 20 is refused after payment and refunded. Paid per call.",
|
|
1004
|
+
"inputSchema": {
|
|
1005
|
+
"type": "object",
|
|
1006
|
+
"properties": {
|
|
1007
|
+
"attribute": {
|
|
1008
|
+
"type": "string",
|
|
1009
|
+
"description": "Name of a data tool whose facts can be benchmarked, e.g. vehicle_complaints"
|
|
1010
|
+
},
|
|
1011
|
+
"field": {
|
|
1012
|
+
"type": "string",
|
|
1013
|
+
"description": "Numeric field to compare, one the data tool declares for Benchmark, e.g. total"
|
|
1014
|
+
},
|
|
1015
|
+
"peers": {
|
|
1016
|
+
"type": "object",
|
|
1017
|
+
"description": "Filters that define the peer set: fields the data tool declares for grouping, e.g. {\"model_year\": 2019}"
|
|
1018
|
+
},
|
|
1019
|
+
"key": {
|
|
1020
|
+
"type": "string",
|
|
1021
|
+
"description": "Entity key of an entity in the peer set, to place its value. Give at most one of key and value"
|
|
1022
|
+
},
|
|
1023
|
+
"value": {
|
|
1024
|
+
"type": "number",
|
|
1025
|
+
"description": "A value to place in the distribution. Give at most one of key and value"
|
|
1026
|
+
},
|
|
1027
|
+
"source": {
|
|
1028
|
+
"type": "string",
|
|
1029
|
+
"description": "Source to read when the attribute has several"
|
|
1030
|
+
}
|
|
1031
|
+
},
|
|
1032
|
+
"required": [
|
|
1033
|
+
"attribute",
|
|
1034
|
+
"field"
|
|
1035
|
+
]
|
|
1036
|
+
},
|
|
1037
|
+
"example": {
|
|
1038
|
+
"attribute": "vehicle_complaints",
|
|
1039
|
+
"field": "total",
|
|
1040
|
+
"peers": {
|
|
1041
|
+
"model_year": 2019
|
|
1042
|
+
},
|
|
1043
|
+
"key": "HONDA:CR-V:2019"
|
|
1044
|
+
}
|
|
1045
|
+
},
|
|
1046
|
+
{
|
|
1047
|
+
"name": "place_permits",
|
|
1048
|
+
"method": "POST",
|
|
1049
|
+
"path": "/v1/tools/lookup/place-permits",
|
|
1050
|
+
"paid": true,
|
|
1051
|
+
"readOnly": true,
|
|
1052
|
+
"title": "Building Permits",
|
|
1053
|
+
"description": "Look up recorded building permits at an exact site address in Chicago or New York City. NYC coverage is the legacy permit issuance dataset, excluding DOB NOW. Supply an NYC borough. Chicago covers permits since 2006, excluding voided or revoked permits. Returns permit type, source status, dates, description, declared value and business contractors where published. Optional issue-date and permit-type filters. No match does not prove no work occurred. Data checked daily; missing, failed or stale ingests fail the call. Outside coverage is refused before payment. Paid per call.",
|
|
1054
|
+
"inputSchema": {
|
|
1055
|
+
"type": "object",
|
|
1056
|
+
"properties": {
|
|
1057
|
+
"street_address": {
|
|
1058
|
+
"type": "string",
|
|
1059
|
+
"description": "Site street address with number and source spelling; no unit or city"
|
|
1060
|
+
},
|
|
1061
|
+
"city": {
|
|
1062
|
+
"type": "string",
|
|
1063
|
+
"description": "Chicago or New York City; an NYC borough name is also accepted"
|
|
1064
|
+
},
|
|
1065
|
+
"state": {
|
|
1066
|
+
"type": "string",
|
|
1067
|
+
"description": "Two-letter US state code"
|
|
1068
|
+
},
|
|
1069
|
+
"borough": {
|
|
1070
|
+
"type": "string",
|
|
1071
|
+
"description": "NYC borough, required when city is New York City"
|
|
1072
|
+
},
|
|
1073
|
+
"issued_from": {
|
|
1074
|
+
"type": "string",
|
|
1075
|
+
"description": "First issue date inclusive, YYYY-MM-DD"
|
|
1076
|
+
},
|
|
1077
|
+
"issued_to": {
|
|
1078
|
+
"type": "string",
|
|
1079
|
+
"description": "Last issue date inclusive, YYYY-MM-DD"
|
|
1080
|
+
},
|
|
1081
|
+
"permit_type": {
|
|
1082
|
+
"type": "string",
|
|
1083
|
+
"description": "Exact source permit type, case insensitive"
|
|
1084
|
+
},
|
|
1085
|
+
"limit": {
|
|
1086
|
+
"type": "integer",
|
|
1087
|
+
"description": "Page size, 1-100, default 50"
|
|
1088
|
+
},
|
|
1089
|
+
"offset": {
|
|
1090
|
+
"type": "integer",
|
|
1091
|
+
"description": "Results to skip, 0-10000, default 0"
|
|
1092
|
+
}
|
|
1093
|
+
},
|
|
1094
|
+
"required": [
|
|
1095
|
+
"street_address",
|
|
1096
|
+
"city",
|
|
1097
|
+
"state"
|
|
1098
|
+
]
|
|
1099
|
+
},
|
|
1100
|
+
"example": {
|
|
1101
|
+
"street_address": "7529 N CLARK ST",
|
|
1102
|
+
"city": "Chicago",
|
|
1103
|
+
"state": "IL"
|
|
1104
|
+
}
|
|
1105
|
+
},
|
|
1106
|
+
{
|
|
1107
|
+
"name": "watch_update",
|
|
1108
|
+
"method": "PATCH",
|
|
1109
|
+
"path": "/v1/tools/watch/{watch_id}",
|
|
1110
|
+
"paid": false,
|
|
1111
|
+
"readOnly": false,
|
|
1112
|
+
"title": "Change a Watch",
|
|
1113
|
+
"description": "Change a watch: its spending cap (`max_spend`, raising it resumes a watch paused at its cap), its webhook (`webhook_url`), or pause or resume it (`paused`). Give at least one. Free.",
|
|
1114
|
+
"inputSchema": {
|
|
1115
|
+
"type": "object",
|
|
1116
|
+
"properties": {
|
|
1117
|
+
"watch_id": {
|
|
1118
|
+
"type": "string",
|
|
1119
|
+
"description": "Watch id from oneshot_watch or oneshot_watch_list"
|
|
1120
|
+
},
|
|
1121
|
+
"max_spend": {
|
|
1122
|
+
"type": "number",
|
|
1123
|
+
"description": "A new spending cap in dollars, at most 100"
|
|
1124
|
+
},
|
|
1125
|
+
"webhook_url": {
|
|
1126
|
+
"type": "string",
|
|
1127
|
+
"description": "A new HTTPS webhook URL; a new URL gets a new signing secret"
|
|
1128
|
+
},
|
|
1129
|
+
"paused": {
|
|
1130
|
+
"type": "boolean",
|
|
1131
|
+
"description": "true pauses the watch; false resumes one the agent paused"
|
|
1132
|
+
}
|
|
1133
|
+
},
|
|
1134
|
+
"required": [
|
|
1135
|
+
"watch_id"
|
|
1136
|
+
]
|
|
1137
|
+
},
|
|
1138
|
+
"example": {
|
|
1139
|
+
"watch_id": "3f1c2b9e-0000-4000-8000-000000000000",
|
|
1140
|
+
"paused": true
|
|
1141
|
+
}
|
|
1142
|
+
},
|
|
1143
|
+
{
|
|
1144
|
+
"name": "changes",
|
|
1145
|
+
"method": "POST",
|
|
1146
|
+
"path": "/v1/tools/changes",
|
|
1147
|
+
"paid": true,
|
|
1148
|
+
"readOnly": true,
|
|
1149
|
+
"title": "Changes",
|
|
1150
|
+
"description": "What changed about one entity since a date, from the observations OneShot recorded: each change has the earlier value, the later value, when it was seen and the source. Give `attribute` (the name of a data tool that keeps history), `since`, and exactly one of `key` and `input`. A window with no changes is a completed, charged result. Paid per call.",
|
|
1151
|
+
"inputSchema": {
|
|
1152
|
+
"type": "object",
|
|
1153
|
+
"properties": {
|
|
1154
|
+
"attribute": {
|
|
1155
|
+
"type": "string",
|
|
1156
|
+
"description": "Name of a data tool that keeps history, e.g. vehicle_identification"
|
|
1157
|
+
},
|
|
1158
|
+
"key": {
|
|
1159
|
+
"type": "string",
|
|
1160
|
+
"description": "Entity key the data tool declares. Give exactly one of key and input"
|
|
1161
|
+
},
|
|
1162
|
+
"input": {
|
|
1163
|
+
"type": "object",
|
|
1164
|
+
"description": "Input a search was called with, for a stored search. Give exactly one of key and input"
|
|
1165
|
+
},
|
|
1166
|
+
"source": {
|
|
1167
|
+
"type": "string",
|
|
1168
|
+
"description": "Source to read when the attribute has several"
|
|
1169
|
+
},
|
|
1170
|
+
"since": {
|
|
1171
|
+
"type": "string",
|
|
1172
|
+
"description": "First day of the window, YYYY-MM-DD"
|
|
1173
|
+
},
|
|
1174
|
+
"until": {
|
|
1175
|
+
"type": "string",
|
|
1176
|
+
"description": "Last day of the window, YYYY-MM-DD (default: today)"
|
|
1177
|
+
},
|
|
1178
|
+
"limit": {
|
|
1179
|
+
"type": "integer",
|
|
1180
|
+
"description": "Most changes to return, oldest first (1-200, default 50)"
|
|
1181
|
+
}
|
|
1182
|
+
},
|
|
1183
|
+
"required": [
|
|
1184
|
+
"attribute",
|
|
1185
|
+
"since"
|
|
1186
|
+
]
|
|
1187
|
+
},
|
|
1188
|
+
"example": {
|
|
1189
|
+
"attribute": "vehicle_identification",
|
|
1190
|
+
"key": "1HGCM82633A004352",
|
|
1191
|
+
"since": "2026-01-01"
|
|
1192
|
+
}
|
|
1193
|
+
},
|
|
1194
|
+
{
|
|
1195
|
+
"name": "compute_budget",
|
|
1196
|
+
"method": "GET",
|
|
1197
|
+
"path": "/v1/compute/{goal_id}/budget",
|
|
1198
|
+
"paid": false,
|
|
1199
|
+
"readOnly": true,
|
|
1200
|
+
"title": "Compute Budget",
|
|
1201
|
+
"description": "Read what a compute goal has reserved, spent and has left. Free.",
|
|
1202
|
+
"inputSchema": {
|
|
1203
|
+
"type": "object",
|
|
1204
|
+
"properties": {
|
|
1205
|
+
"goal_id": {
|
|
1206
|
+
"type": "string",
|
|
1207
|
+
"description": "The goal id"
|
|
1208
|
+
}
|
|
1209
|
+
},
|
|
1210
|
+
"required": [
|
|
1211
|
+
"goal_id"
|
|
1212
|
+
]
|
|
1213
|
+
},
|
|
1214
|
+
"example": {
|
|
1215
|
+
"goal_id": "goal_01HX"
|
|
1216
|
+
}
|
|
1217
|
+
},
|
|
1218
|
+
{
|
|
1219
|
+
"name": "watch_delete",
|
|
1220
|
+
"method": "DELETE",
|
|
1221
|
+
"path": "/v1/tools/watch/{watch_id}",
|
|
1222
|
+
"paid": false,
|
|
1223
|
+
"readOnly": false,
|
|
1224
|
+
"title": "Delete a Watch",
|
|
1225
|
+
"description": "Delete a watch so it delivers no more changes. Free.",
|
|
1226
|
+
"inputSchema": {
|
|
1227
|
+
"type": "object",
|
|
1228
|
+
"properties": {
|
|
1229
|
+
"watch_id": {
|
|
1230
|
+
"type": "string",
|
|
1231
|
+
"description": "Watch id from oneshot_watch or oneshot_watch_list"
|
|
1232
|
+
}
|
|
1233
|
+
},
|
|
1234
|
+
"required": [
|
|
1235
|
+
"watch_id"
|
|
1236
|
+
]
|
|
1237
|
+
},
|
|
1238
|
+
"example": {
|
|
1239
|
+
"watch_id": "3f1c2b9e-0000-4000-8000-000000000000"
|
|
1240
|
+
}
|
|
1241
|
+
},
|
|
1242
|
+
{
|
|
1243
|
+
"name": "email_analytics",
|
|
1244
|
+
"method": "GET",
|
|
1245
|
+
"path": "/v1/tools/email/analytics/{domain}",
|
|
1246
|
+
"paid": false,
|
|
1247
|
+
"readOnly": true,
|
|
1248
|
+
"title": "Email Analytics",
|
|
1249
|
+
"description": "Campaign analytics for one of the agent's sending domains: totals for sent, delivered, opened and bounced emails, opens, clicks, delivery, open and click rates, and the recent messages. Free. Domains are listed by oneshot_list_domains.",
|
|
1250
|
+
"inputSchema": {
|
|
1251
|
+
"type": "object",
|
|
1252
|
+
"properties": {
|
|
1253
|
+
"domain": {
|
|
1254
|
+
"type": "string",
|
|
1255
|
+
"description": "A sending domain from oneshot_list_domains"
|
|
1256
|
+
}
|
|
1257
|
+
},
|
|
1258
|
+
"required": [
|
|
1259
|
+
"domain"
|
|
1260
|
+
]
|
|
1261
|
+
},
|
|
1262
|
+
"example": {
|
|
1263
|
+
"domain": "mail.example.com"
|
|
1264
|
+
}
|
|
1265
|
+
},
|
|
1266
|
+
{
|
|
1267
|
+
"name": "voice_inbound_get",
|
|
1268
|
+
"method": "GET",
|
|
1269
|
+
"path": "/v1/tools/voice/numbers/{phone_number_id}/inbound",
|
|
1270
|
+
"paid": false,
|
|
1271
|
+
"readOnly": true,
|
|
1272
|
+
"title": "Get Call Answering Settings",
|
|
1273
|
+
"description": "Read how one of the agent's numbers answers inbound calls: the prompt, greeting, allowed tools, hours and whether it is enabled. Free.",
|
|
1274
|
+
"inputSchema": {
|
|
1275
|
+
"type": "object",
|
|
1276
|
+
"properties": {
|
|
1277
|
+
"phone_number_id": {
|
|
1278
|
+
"type": "string",
|
|
1279
|
+
"description": "Number id from oneshot_voice_numbers"
|
|
1280
|
+
}
|
|
1281
|
+
},
|
|
1282
|
+
"required": [
|
|
1283
|
+
"phone_number_id"
|
|
1284
|
+
]
|
|
1285
|
+
},
|
|
1286
|
+
"example": {
|
|
1287
|
+
"phone_number_id": "pn_01HX"
|
|
1288
|
+
}
|
|
1289
|
+
},
|
|
1290
|
+
{
|
|
1291
|
+
"name": "linkedin_sync_run",
|
|
1292
|
+
"method": "GET",
|
|
1293
|
+
"path": "/v1/tools/linkedin/sync/{run_id}",
|
|
1294
|
+
"paid": false,
|
|
1295
|
+
"readOnly": true,
|
|
1296
|
+
"title": "LinkedIn Sync Run",
|
|
1297
|
+
"description": "Read one LinkedIn history-sync run: its state, the pages and messages it fetched and why it ended. Free. The run id comes from oneshot_linkedin_sync or oneshot_linkedin_accounts with account_id.",
|
|
1298
|
+
"inputSchema": {
|
|
1299
|
+
"type": "object",
|
|
1300
|
+
"properties": {
|
|
1301
|
+
"run_id": {
|
|
1302
|
+
"type": "string",
|
|
1303
|
+
"description": "Sync run id"
|
|
1304
|
+
}
|
|
1305
|
+
},
|
|
1306
|
+
"required": [
|
|
1307
|
+
"run_id"
|
|
1308
|
+
]
|
|
1309
|
+
},
|
|
1310
|
+
"example": {
|
|
1311
|
+
"run_id": "run_01HX"
|
|
1312
|
+
}
|
|
1313
|
+
},
|
|
1314
|
+
{
|
|
1315
|
+
"name": "watch_list",
|
|
1316
|
+
"method": "GET",
|
|
1317
|
+
"path": "/v1/tools/watch",
|
|
1318
|
+
"paid": false,
|
|
1319
|
+
"readOnly": true,
|
|
1320
|
+
"title": "List Watches",
|
|
1321
|
+
"description": "List the agent's watches with their state, spend and the price of one change. Free.",
|
|
1322
|
+
"inputSchema": {
|
|
1323
|
+
"type": "object",
|
|
1324
|
+
"properties": {},
|
|
1325
|
+
"required": []
|
|
1326
|
+
},
|
|
1327
|
+
"example": {}
|
|
1328
|
+
},
|
|
1329
|
+
{
|
|
1330
|
+
"name": "notifications_mark_all_read",
|
|
1331
|
+
"method": "PATCH",
|
|
1332
|
+
"path": "/v1/tools/notifications/read-all",
|
|
1333
|
+
"paid": false,
|
|
1334
|
+
"readOnly": false,
|
|
1335
|
+
"title": "Mark All Notifications Read",
|
|
1336
|
+
"description": "Mark every notification of this agent as read. Free. Mark a single one with oneshot_mark_notification_read.",
|
|
1337
|
+
"inputSchema": {
|
|
1338
|
+
"type": "object",
|
|
1339
|
+
"properties": {},
|
|
1340
|
+
"required": []
|
|
1341
|
+
},
|
|
1342
|
+
"example": {}
|
|
1343
|
+
},
|
|
1344
|
+
{
|
|
1345
|
+
"name": "company_sanctions",
|
|
1346
|
+
"method": "POST",
|
|
1347
|
+
"path": "/v1/tools/lookup/company-sanctions",
|
|
1348
|
+
"paid": true,
|
|
1349
|
+
"readOnly": true,
|
|
1350
|
+
"title": "Sanctions Listing (company)",
|
|
1351
|
+
"description": "Check a company name against the US Treasury's list of Specially Designated Nationals. Returns the entries that match, each with a score, the name that matched and the entry as the list publishes it. `min_score` (0.5 to 1, default 0.85) sets the lowest score returned and `limit` the most matches (1 to 25, default 10); `total` counts all matches at or above `min_score`. A screening aid, not a legal determination. No match means no entry on the lists named scored at or above the minimum; it does not mean the party is clear. Paid per call.",
|
|
1352
|
+
"inputSchema": {
|
|
1353
|
+
"type": "object",
|
|
1354
|
+
"properties": {
|
|
1355
|
+
"name": {
|
|
1356
|
+
"type": "string",
|
|
1357
|
+
"description": "The company name to check, 2 to 200 characters, free text. Word order and punctuation do not matter"
|
|
1358
|
+
},
|
|
1359
|
+
"min_score": {
|
|
1360
|
+
"type": "number",
|
|
1361
|
+
"description": "The lowest score of a match to return, 0.5 to 1 (default 0.85)"
|
|
1362
|
+
},
|
|
1363
|
+
"limit": {
|
|
1364
|
+
"type": "integer",
|
|
1365
|
+
"description": "Most matches to return, highest score first (1-25, default 10)"
|
|
1366
|
+
}
|
|
1367
|
+
},
|
|
1368
|
+
"required": [
|
|
1369
|
+
"name"
|
|
1370
|
+
]
|
|
1371
|
+
},
|
|
1372
|
+
"example": {
|
|
1373
|
+
"name": "Banco Nacional de Cuba",
|
|
1374
|
+
"min_score": 0.85,
|
|
1375
|
+
"limit": 10
|
|
1376
|
+
}
|
|
1377
|
+
},
|
|
1378
|
+
{
|
|
1379
|
+
"name": "person_sanctions",
|
|
1380
|
+
"method": "POST",
|
|
1381
|
+
"path": "/v1/tools/lookup/person-sanctions",
|
|
1382
|
+
"paid": true,
|
|
1383
|
+
"readOnly": true,
|
|
1384
|
+
"title": "Sanctions Listing (person)",
|
|
1385
|
+
"description": "Check a person name against the US Treasury's list of Specially Designated Nationals. Returns the entries that match, each with a score, the name that matched and the entry as the list publishes it. `min_score` (0.5 to 1, default 0.85) sets the lowest score returned and `limit` the most matches (1 to 25, default 10); `total` counts all matches at or above `min_score`. A screening aid, not a legal determination. No match means no entry on the lists named scored at or above the minimum; it does not mean the party is clear. Paid per call.",
|
|
1386
|
+
"inputSchema": {
|
|
1387
|
+
"type": "object",
|
|
1388
|
+
"properties": {
|
|
1389
|
+
"name": {
|
|
1390
|
+
"type": "string",
|
|
1391
|
+
"description": "The person name to check, 2 to 200 characters, free text. Word order, accents and punctuation do not matter"
|
|
1392
|
+
},
|
|
1393
|
+
"min_score": {
|
|
1394
|
+
"type": "number",
|
|
1395
|
+
"description": "The lowest score of a match to return, 0.5 to 1 (default 0.85)"
|
|
1396
|
+
},
|
|
1397
|
+
"limit": {
|
|
1398
|
+
"type": "integer",
|
|
1399
|
+
"description": "Most matches to return, highest score first (1-25, default 10)"
|
|
1400
|
+
}
|
|
1401
|
+
},
|
|
1402
|
+
"required": [
|
|
1403
|
+
"name"
|
|
1404
|
+
]
|
|
1405
|
+
},
|
|
1406
|
+
"example": {
|
|
1407
|
+
"name": "Vladimir Putin",
|
|
1408
|
+
"min_score": 0.85,
|
|
1409
|
+
"limit": 10
|
|
1410
|
+
}
|
|
1411
|
+
},
|
|
1412
|
+
{
|
|
1413
|
+
"name": "watch",
|
|
1414
|
+
"method": "POST",
|
|
1415
|
+
"path": "/v1/tools/watch",
|
|
1416
|
+
"paid": false,
|
|
1417
|
+
"readOnly": false,
|
|
1418
|
+
"title": "Watch",
|
|
1419
|
+
"description": "Be told when one attribute of one entity changes. Creating the watch is free; each change delivered is charged from prepaid credits, up to `max_spend` dollars. Only attributes we ingest on a schedule can be watched; a refusal names them. `key` is the entity's own identifier, as Changes takes it. Give `webhook_url` (HTTPS) to have each change sent, signed with a secret returned once.",
|
|
1420
|
+
"inputSchema": {
|
|
1421
|
+
"type": "object",
|
|
1422
|
+
"properties": {
|
|
1423
|
+
"entity_type": {
|
|
1424
|
+
"type": "string",
|
|
1425
|
+
"description": "The kind of entity, for example \"company\" or \"record\""
|
|
1426
|
+
},
|
|
1427
|
+
"attribute": {
|
|
1428
|
+
"type": "string",
|
|
1429
|
+
"description": "The attribute to watch, for example \"sanctions\""
|
|
1430
|
+
},
|
|
1431
|
+
"key": {
|
|
1432
|
+
"type": "string",
|
|
1433
|
+
"description": "The entity's key, the source's own identifier, as Changes takes it"
|
|
1434
|
+
},
|
|
1435
|
+
"max_spend": {
|
|
1436
|
+
"type": "number",
|
|
1437
|
+
"description": "Most to spend on this watch in dollars: at least the price of one change, at most 100"
|
|
1438
|
+
},
|
|
1439
|
+
"webhook_url": {
|
|
1440
|
+
"type": "string",
|
|
1441
|
+
"description": "HTTPS URL to send each change to"
|
|
1442
|
+
}
|
|
1443
|
+
},
|
|
1444
|
+
"required": [
|
|
1445
|
+
"entity_type",
|
|
1446
|
+
"attribute",
|
|
1447
|
+
"key",
|
|
1448
|
+
"max_spend"
|
|
1449
|
+
]
|
|
1450
|
+
},
|
|
1451
|
+
"example": {
|
|
1452
|
+
"entity_type": "company",
|
|
1453
|
+
"attribute": "sanctions",
|
|
1454
|
+
"key": "acme-corp",
|
|
1455
|
+
"max_spend": 5
|
|
1456
|
+
}
|
|
1457
|
+
}
|
|
1458
|
+
];
|