@oneshot-agent/mcp-server 0.49.0 → 0.51.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 +7 -6
- package/dist/index.js +1 -1
- package/dist/tools/annotations.d.ts +4 -2
- package/dist/tools/annotations.js +28 -19
- package/dist/tools/compute.d.ts +0 -5
- package/dist/tools/compute.js +197 -8
- package/dist/tools/connections.d.ts +1 -1
- package/dist/tools/connections.js +1 -1
- package/dist/tools/discover.js +1 -1
- package/dist/tools/domains.js +1 -1
- package/dist/tools/email.js +3 -15
- package/dist/tools/index.js +12 -1
- package/dist/tools/linkedin.js +1 -1
- package/dist/tools/local.js +1 -3
- package/dist/tools/lookup-call.d.ts +13 -0
- package/dist/tools/lookup-call.js +45 -0
- package/dist/tools/lookup-manifest.generated.d.ts +2 -0
- package/dist/tools/lookup-manifest.generated.js +2349 -33
- package/dist/tools/lookup.js +6 -1
- package/dist/tools/predict-schema.generated.d.ts +37 -2
- package/dist/tools/predict-schema.generated.js +52 -3
- package/dist/tools/predict.d.ts +1 -1
- package/dist/tools/predict.js +1 -1
- package/dist/tools/search.js +6 -0
- package/dist/tools/solve-schema.generated.d.ts +2 -8
- package/dist/tools/solve-schema.generated.js +6 -15
- package/dist/tools/untrusted-tools.generated.js +128 -0
- package/package.json +3 -3
|
@@ -2,6 +2,68 @@
|
|
|
2
2
|
// run `bun scripts/generate-lookup-tools.ts` after adding or changing a lookup tool.
|
|
3
3
|
// Plain data on purpose: the published package must not import from apps/.
|
|
4
4
|
export const LOOKUP_MANIFEST = [
|
|
5
|
+
{
|
|
6
|
+
"name": "company_adviser_registration",
|
|
7
|
+
"path": "lookup/company-adviser-registration",
|
|
8
|
+
"title": "Adviser Registration",
|
|
9
|
+
"description": "Returns investment adviser firms from the US Securities and Exchange Commission's public disclosure register matching a CRD number or name: whether each is registered with the SEC or states or files as an exempt reporting adviser, each registration with its status and date, notice filings, SEC file number and main office. Broker-dealer registrations and individual representatives are not covered. Give exactly one of `crd` and `name`. A CRD number returns `profile`, the firm's full record, with `total` 1; `profile` is null and `total` 0 when the number is not an investment adviser in the register. A name returns `matches`, a list of firms to pick from, best match first, each with the CRD number to call again with; `profile` is then null. A name is a text match against current and former names and the SEC file number, so similarly named firms come back too. `total` counts every register record that matched, including firms registered only as broker-dealers, which are not returned. `adviser_status` is `inactive` for a firm no longer registered or reporting; the register keeps such firms for ten years. `registrations` lists each SEC or state registration with its status word (`Approved`, `Terminated`) and effective date; `exempt_reporting` lists exempt reporting filings; `notice_filings` lists the states an SEC-registered adviser has notice filed in. Assets under management, brochures, individual representatives and broker-dealer data are not returned. Dates are YYYY-MM-DD; a date the register writes in an unreadable form is null.",
|
|
10
|
+
"inputSchema": {
|
|
11
|
+
"type": "object",
|
|
12
|
+
"properties": {
|
|
13
|
+
"crd": {
|
|
14
|
+
"type": "integer",
|
|
15
|
+
"description": "The firm's CRD number, for example 149117. An exact match that returns the full profile. From 1 to 99999999."
|
|
16
|
+
},
|
|
17
|
+
"name": {
|
|
18
|
+
"type": "string",
|
|
19
|
+
"description": "The firm's name, for example Betterment. A text match against current and former names and the SEC file number; returns a list to pick from. 2 to 100 characters."
|
|
20
|
+
},
|
|
21
|
+
"limit": {
|
|
22
|
+
"type": "integer",
|
|
23
|
+
"description": "Most firms to return for a name; ignored with a CRD number. From 1 to 12. Defaults to `5`."
|
|
24
|
+
},
|
|
25
|
+
"fresh": {
|
|
26
|
+
"type": "boolean",
|
|
27
|
+
"description": "Look the record up again instead of using OneShot's stored copy from an earlier lookup, and refresh that copy. Off by default: a record stored within its freshness window is returned as is, with cached: true and its fetched_at."
|
|
28
|
+
}
|
|
29
|
+
},
|
|
30
|
+
"required": []
|
|
31
|
+
},
|
|
32
|
+
"example": {
|
|
33
|
+
"crd": 149117
|
|
34
|
+
}
|
|
35
|
+
},
|
|
36
|
+
{
|
|
37
|
+
"name": "aircraft_registration",
|
|
38
|
+
"path": "lookup/aircraft-registration",
|
|
39
|
+
"title": "Aircraft Registration",
|
|
40
|
+
"description": "Find US civil aircraft and their registered owners in the daily FAA registry. Search by N-number, six-digit hexadecimal Mode S code or owner-name prefix. No street addresses are returned. Registration does not establish who flies the aircraft or its current location. An empty result with coverage.available true means no match in the held release. False means no evidence either way. Observed fields are registry values, with code labels and date formatting decoded. There are no derived aircraft fields. Owner names match normalized uppercase text prefixes. Lists default to 25 rows, at most 50. Status and aircraft type retain FAA codes. The source refreshes daily at 11:30 p.m. Central. coverage.as_of dates the held release; newer registrations may be absent.",
|
|
41
|
+
"inputSchema": {
|
|
42
|
+
"type": "object",
|
|
43
|
+
"properties": {
|
|
44
|
+
"registration": {
|
|
45
|
+
"type": "string",
|
|
46
|
+
"description": "US N-number, such as N123AB"
|
|
47
|
+
},
|
|
48
|
+
"icao24": {
|
|
49
|
+
"type": "string",
|
|
50
|
+
"description": "Six hexadecimal Mode S digits"
|
|
51
|
+
},
|
|
52
|
+
"owner_name": {
|
|
53
|
+
"type": "string",
|
|
54
|
+
"description": "Registered owner name prefix. 1 to 200 characters. Owner name must be valid Unicode without null characters."
|
|
55
|
+
},
|
|
56
|
+
"limit": {
|
|
57
|
+
"type": "integer",
|
|
58
|
+
"description": "Maximum owner-search rows. From 1 to 50. Defaults to `25`."
|
|
59
|
+
}
|
|
60
|
+
},
|
|
61
|
+
"required": []
|
|
62
|
+
},
|
|
63
|
+
"example": {
|
|
64
|
+
"registration": "N123AB"
|
|
65
|
+
}
|
|
66
|
+
},
|
|
5
67
|
{
|
|
6
68
|
"name": "company_bank_profile",
|
|
7
69
|
"path": "lookup/company-bank-profile",
|
|
@@ -33,6 +95,90 @@ export const LOOKUP_MANIFEST = [
|
|
|
33
95
|
"fdic_certificate": 59113
|
|
34
96
|
}
|
|
35
97
|
},
|
|
98
|
+
{
|
|
99
|
+
"name": "place_camera_snapshot",
|
|
100
|
+
"path": "lookup/place-camera-snapshot",
|
|
101
|
+
"title": "Camera Check",
|
|
102
|
+
"description": "Finds public road cameras run by transport authorities, nearest first, and fetches the nearest available frame. Some cameras refresh only every few minutes. Source fields are observed; distance, converted coordinates, frame_age_s and offline are derived. Coverage reports how many cameras the catalogue could find, even when no frame was fetched. An empty list with catalogue_available true means the loaded catalogue was searched and no cameras were in range. With catalogue_available false it provides no evidence either way. Neither proves a physical scene is clear. coverage.networks_loaded lists catalogues loaded within 48 hours; coverage is partial outside those networks. Stored cameras remain visible when catalogue refreshes fail. Fetches at most three frames in nearest order, stopping after a usable frame. Failed or older-than-30-minute frames are offline and remain listed. Unchecked cameras have null offline and frame_age_s. frame_captured_at comes from the image Last-Modified header; absent or future timestamps are null. HTTP Date and catalogue update times are not image capture times. Coordinates converted from Web Mercator are under derived.latitude and derived.longitude, with the original position under observed.source_position. Other coordinates are under observed. radius_km defaults to 5 (maximum 50); limit defaults to 3 (maximum 10). Return attribution alongside any displayed frame. TxDOT frame URLs return a JSON snippet containing a base64 JPEG.",
|
|
103
|
+
"inputSchema": {
|
|
104
|
+
"type": "object",
|
|
105
|
+
"properties": {
|
|
106
|
+
"latitude": {
|
|
107
|
+
"type": "number",
|
|
108
|
+
"description": "Latitude in decimal degrees. From -90 to 90."
|
|
109
|
+
},
|
|
110
|
+
"longitude": {
|
|
111
|
+
"type": "number",
|
|
112
|
+
"description": "Longitude in decimal degrees. From -180 to 180."
|
|
113
|
+
},
|
|
114
|
+
"radius_km": {
|
|
115
|
+
"type": "number",
|
|
116
|
+
"description": "Search radius in kilometres. From 0 to 50. Defaults to `5`."
|
|
117
|
+
},
|
|
118
|
+
"limit": {
|
|
119
|
+
"type": "integer",
|
|
120
|
+
"description": "Most cameras returned. From 1 to 10. Defaults to `3`."
|
|
121
|
+
}
|
|
122
|
+
},
|
|
123
|
+
"required": [
|
|
124
|
+
"latitude",
|
|
125
|
+
"longitude"
|
|
126
|
+
]
|
|
127
|
+
},
|
|
128
|
+
"example": {
|
|
129
|
+
"latitude": 51.60067,
|
|
130
|
+
"longitude": -0.01594
|
|
131
|
+
}
|
|
132
|
+
},
|
|
133
|
+
{
|
|
134
|
+
"name": "company_care_quality",
|
|
135
|
+
"path": "lookup/company-care-quality",
|
|
136
|
+
"title": "Care Quality Ratings",
|
|
137
|
+
"description": "Returns official star ratings of a US hospital, nursing home, home health agency, hospice or dialysis facility by CMS Certification Number or name, from the US Centers for Medicare & Medicaid Services: overall rating from 1 to 5, plus nursing home inspection, quality and staffing ratings. A null rating means the source published none. rating_name identifies the rating for each facility_type: hospital overall quality, nursing home overall five-star, home health patient care quality, hospice family caregiver survey summary, or dialysis facility five-star. Names match substrings; use has_more and the CCN to distinguish facilities. No match completes with facilities: []. Use place_hospitals to list hospitals in a ZIP code and company_medicare_ownership for ownership details. Only the current release is served; history begins with our first observation.",
|
|
138
|
+
"inputSchema": {
|
|
139
|
+
"type": "object",
|
|
140
|
+
"properties": {
|
|
141
|
+
"facility_type": {
|
|
142
|
+
"type": "string",
|
|
143
|
+
"enum": [
|
|
144
|
+
"hospital",
|
|
145
|
+
"nursing_home",
|
|
146
|
+
"home_health",
|
|
147
|
+
"hospice",
|
|
148
|
+
"dialysis"
|
|
149
|
+
],
|
|
150
|
+
"description": "Which register to read; each kind of facility is rated in its own dataset"
|
|
151
|
+
},
|
|
152
|
+
"ccn": {
|
|
153
|
+
"type": "string",
|
|
154
|
+
"description": "The facility CMS Certification Number (Medicare provider number). A CMS Certification Number is six digits or capital letters."
|
|
155
|
+
},
|
|
156
|
+
"facility_name": {
|
|
157
|
+
"type": "string",
|
|
158
|
+
"description": "Case-insensitive substring of the facility name. 3 to 100 characters."
|
|
159
|
+
},
|
|
160
|
+
"state": {
|
|
161
|
+
"type": "string",
|
|
162
|
+
"description": "State abbreviation; only with facility_name"
|
|
163
|
+
},
|
|
164
|
+
"limit": {
|
|
165
|
+
"type": "integer",
|
|
166
|
+
"description": "Most facilities to return. From 1 to 10. Defaults to `5`."
|
|
167
|
+
},
|
|
168
|
+
"fresh": {
|
|
169
|
+
"type": "boolean",
|
|
170
|
+
"description": "Look the record up again instead of using OneShot's stored copy from an earlier lookup, and refresh that copy. Off by default: a record stored within its freshness window is returned as is, with cached: true and its fetched_at."
|
|
171
|
+
}
|
|
172
|
+
},
|
|
173
|
+
"required": [
|
|
174
|
+
"facility_type"
|
|
175
|
+
]
|
|
176
|
+
},
|
|
177
|
+
"example": {
|
|
178
|
+
"facility_type": "hospital",
|
|
179
|
+
"ccn": "240010"
|
|
180
|
+
}
|
|
181
|
+
},
|
|
36
182
|
{
|
|
37
183
|
"name": "record_clinical_trials_find",
|
|
38
184
|
"path": "find/record-clinical-trials",
|
|
@@ -298,6 +444,31 @@ export const LOOKUP_MANIFEST = [
|
|
|
298
444
|
"license_number": "ABSHEC*345PS"
|
|
299
445
|
}
|
|
300
446
|
},
|
|
447
|
+
{
|
|
448
|
+
"name": "product_cosmetic_adverse_events",
|
|
449
|
+
"path": "lookup/product-cosmetic-adverse-events",
|
|
450
|
+
"title": "Cosmetic Adverse Events",
|
|
451
|
+
"description": "Lists the reactions and outcomes most often named in adverse event reports about cosmetic products sent to the US Food and Drug Administration, with the number of reports naming each. Reports are unverified, a report does not show that the product caused the reaction, and the source says its data must not guide medical care. The name matches any product named on a report, including products the reporter did not suspect; common words can match unrelated reports. One report can name several reactions and outcomes. The source updates infrequently; as_of gives its date. For drugs use Drug Adverse Events; for devices use Device Adverse Events.",
|
|
452
|
+
"inputSchema": {
|
|
453
|
+
"type": "object",
|
|
454
|
+
"properties": {
|
|
455
|
+
"product_name": {
|
|
456
|
+
"type": "string",
|
|
457
|
+
"description": "Cosmetic product name, matched as a phrase. 2 to 100 characters."
|
|
458
|
+
},
|
|
459
|
+
"limit": {
|
|
460
|
+
"type": "integer",
|
|
461
|
+
"description": "The most reactions to return. From 1 to 25. Defaults to `10`."
|
|
462
|
+
}
|
|
463
|
+
},
|
|
464
|
+
"required": [
|
|
465
|
+
"product_name"
|
|
466
|
+
]
|
|
467
|
+
},
|
|
468
|
+
"example": {
|
|
469
|
+
"product_name": "dry shampoo"
|
|
470
|
+
}
|
|
471
|
+
},
|
|
301
472
|
{
|
|
302
473
|
"name": "record_court_cases_find",
|
|
303
474
|
"path": "find/record-court-cases",
|
|
@@ -425,6 +596,45 @@ export const LOOKUP_MANIFEST = [
|
|
|
425
596
|
"limit": 1
|
|
426
597
|
}
|
|
427
598
|
},
|
|
599
|
+
{
|
|
600
|
+
"name": "product_device_adverse_events",
|
|
601
|
+
"path": "lookup/product-device-adverse-events",
|
|
602
|
+
"title": "Device Adverse Events",
|
|
603
|
+
"description": "Counts adverse event reports to the US Food and Drug Administration about a medical device, by name, product code or maker: deaths, injuries and malfunctions reported, and the most named patient or device problems. Reports are unverified, a report does not show the device caused the event, and the source says its data must not guide medical care. Names match phrases; several filters must all match. Device names match brand or generic name. One report can name several devices and problems. A problem count is the reports naming it; terms such as No Clinical Signs, Symptoms or Conditions are the source’s own. For drugs use Drug Adverse Events. The source refreshes weekly.",
|
|
604
|
+
"inputSchema": {
|
|
605
|
+
"type": "object",
|
|
606
|
+
"properties": {
|
|
607
|
+
"device_name": {
|
|
608
|
+
"type": "string",
|
|
609
|
+
"description": "Device brand or generic name. 2 to 100 characters."
|
|
610
|
+
},
|
|
611
|
+
"product_code": {
|
|
612
|
+
"type": "string",
|
|
613
|
+
"description": "Three-letter FDA device product code"
|
|
614
|
+
},
|
|
615
|
+
"manufacturer": {
|
|
616
|
+
"type": "string",
|
|
617
|
+
"description": "Device manufacturer name. 2 to 100 characters."
|
|
618
|
+
},
|
|
619
|
+
"problems": {
|
|
620
|
+
"type": "string",
|
|
621
|
+
"enum": [
|
|
622
|
+
"patient",
|
|
623
|
+
"device"
|
|
624
|
+
],
|
|
625
|
+
"description": "Patient health effects or device failures. Defaults to `\"patient\"`."
|
|
626
|
+
},
|
|
627
|
+
"limit": {
|
|
628
|
+
"type": "integer",
|
|
629
|
+
"description": "The most problems to return. From 1 to 25. Defaults to `10`."
|
|
630
|
+
}
|
|
631
|
+
},
|
|
632
|
+
"required": []
|
|
633
|
+
},
|
|
634
|
+
"example": {
|
|
635
|
+
"product_code": "QFG"
|
|
636
|
+
}
|
|
637
|
+
},
|
|
428
638
|
{
|
|
429
639
|
"name": "product_device_clearances",
|
|
430
640
|
"path": "lookup/product-device-clearances",
|
|
@@ -461,14 +671,41 @@ export const LOOKUP_MANIFEST = [
|
|
|
461
671
|
"limit": 2
|
|
462
672
|
}
|
|
463
673
|
},
|
|
674
|
+
{
|
|
675
|
+
"name": "product_device_identifier",
|
|
676
|
+
"path": "lookup/product-device-identifier",
|
|
677
|
+
"title": "Device Identifier",
|
|
678
|
+
"description": "Returns the US Food and Drug Administration’s identification record for a medical device, by the device identifier or GS1 barcode text on its label: brand, model, labeler, package levels, distribution status, product codes, premarket submission numbers and labeling flags such as sterility, latex and MRI safety. Device naming terms and contacts are excluded. Supply exactly one of device_identifier or udi; udi reads GS1 labels only. A package identifier returns the device inside it; matched_type says which level matched. Lot, serial and dates on a label are not in the database and are not returned. An unknown identifier returns found: false. The source refreshes weekly.",
|
|
679
|
+
"inputSchema": {
|
|
680
|
+
"type": "object",
|
|
681
|
+
"properties": {
|
|
682
|
+
"device_identifier": {
|
|
683
|
+
"type": "string",
|
|
684
|
+
"description": "The device identifier (DI) printed on the label, for example 04063006002252. For HIBCC labels, leave out the leading + and the trailing check character."
|
|
685
|
+
},
|
|
686
|
+
"udi": {
|
|
687
|
+
"type": "string",
|
|
688
|
+
"description": "The full UDI text from a GS1 label, human-readable such as (01)00357599000172(17)250531(10)ABC123 or as scanned. 16 to 200 characters."
|
|
689
|
+
}
|
|
690
|
+
},
|
|
691
|
+
"required": []
|
|
692
|
+
},
|
|
693
|
+
"example": {
|
|
694
|
+
"device_identifier": "04063006002252"
|
|
695
|
+
}
|
|
696
|
+
},
|
|
464
697
|
{
|
|
465
698
|
"name": "place_disasters",
|
|
466
699
|
"path": "lookup/place-disasters",
|
|
467
700
|
"title": "Disaster Declarations",
|
|
468
|
-
"description": "Lists the federal disaster declarations (floods, hurricanes, fires, storms, earthquakes and more) that covered a US county, newest first, from the US Federal Emergency Management Agency. Declarations that cover a whole state are included for every county in it and marked `statewide`. `total` counts every match and can exceed the page returned. Use it to check the hazard history of a property, a policy or a claim location.
|
|
701
|
+
"description": "Lists the federal disaster declarations (floods, hurricanes, fires, storms, earthquakes and more) that covered a US county, newest first, from the US Federal Emergency Management Agency. Declarations that cover a whole state are included for every county in it and marked `statewide`. `total` counts every match and can exceed the page returned. This product uses the Federal Emergency Management Agency’s OpenFEMA API, but is not endorsed by FEMA. The Federal Government or FEMA cannot vouch for the data or analyses derived from these data after the data have been retrieved from the Agency's website(s). Use it to check the hazard history of a property, a policy or a claim location. Give either a `place_id` from `place_resolve`, or both `state` and `county`; never both forms. 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.",
|
|
469
702
|
"inputSchema": {
|
|
470
703
|
"type": "object",
|
|
471
704
|
"properties": {
|
|
705
|
+
"place_id": {
|
|
706
|
+
"type": "string",
|
|
707
|
+
"description": "OneShot place id returned by place_resolve; use instead of state and county"
|
|
708
|
+
},
|
|
472
709
|
"state": {
|
|
473
710
|
"type": "string",
|
|
474
711
|
"description": "State postal code. A state is its two-letter postal code, for example TX."
|
|
@@ -494,10 +731,7 @@ export const LOOKUP_MANIFEST = [
|
|
|
494
731
|
"description": "Most declarations to return, newest first. Default 25. From 1 to 100."
|
|
495
732
|
}
|
|
496
733
|
},
|
|
497
|
-
"required": [
|
|
498
|
-
"state",
|
|
499
|
-
"county"
|
|
500
|
-
]
|
|
734
|
+
"required": []
|
|
501
735
|
},
|
|
502
736
|
"example": {
|
|
503
737
|
"state": "TX",
|
|
@@ -508,6 +742,71 @@ export const LOOKUP_MANIFEST = [
|
|
|
508
742
|
"limit": 1
|
|
509
743
|
}
|
|
510
744
|
},
|
|
745
|
+
{
|
|
746
|
+
"name": "company_domain_registration",
|
|
747
|
+
"path": "lookup/company-domain-registration",
|
|
748
|
+
"title": "Domain Registration",
|
|
749
|
+
"description": "Returns the registry record of a registered domain name through the Registration Data Access Protocol: registrar, registration, expiry and last-change dates, status codes, nameservers and whether DNSSEC is on. It never returns the registrant's name or contacts. Covers top-level domains whose registry is listed in the IANA RDAP directory with an https server; others answer rdap_available false. Give the registered name itself, not a web address or a host under it: a host under a registered name (www.example.com) answers not found. Give an internationalized name in its `xn--` form. `found` false with `rdap_available` true means the registry has no registration for that exact name. `rdap_available` false means the tool could not ask: the IANA RDAP directory lists no registry server for the top-level domain, or lists one reachable over http only (the tool asks over https alone). It does not mean the name is free. Status codes are in the registry's words, for example `client transfer prohibited`. Dates are `YYYY-MM-DD` UTC; a date the registry does not state is null. The registry record carries no owner: the registrant's name and contacts are never returned.",
|
|
750
|
+
"inputSchema": {
|
|
751
|
+
"type": "object",
|
|
752
|
+
"properties": {
|
|
753
|
+
"domain": {
|
|
754
|
+
"type": "string",
|
|
755
|
+
"description": "The registered domain name, for example lockheedmartin.com. Give the name itself, not a web address or a host under it (www.example.com answers not found); an internationalized name in its xn-- form. A registered domain name in lower-case ASCII, such as lockheedmartin.com."
|
|
756
|
+
},
|
|
757
|
+
"fresh": {
|
|
758
|
+
"type": "boolean",
|
|
759
|
+
"description": "Look the record up again instead of using OneShot's stored copy from an earlier lookup, and refresh that copy. Off by default: a record stored within its freshness window is returned as is, with cached: true and its fetched_at."
|
|
760
|
+
}
|
|
761
|
+
},
|
|
762
|
+
"required": [
|
|
763
|
+
"domain"
|
|
764
|
+
]
|
|
765
|
+
},
|
|
766
|
+
"example": {
|
|
767
|
+
"domain": "lockheedmartin.com"
|
|
768
|
+
}
|
|
769
|
+
},
|
|
770
|
+
{
|
|
771
|
+
"name": "place_drinking_water",
|
|
772
|
+
"path": "lookup/place-drinking-water",
|
|
773
|
+
"title": "Drinking Water",
|
|
774
|
+
"description": "Returns public water systems serving a US county and their drinking water compliance records from the US Environmental Protection Agency, largest population first. Includes enforcement priority, violation categories, contaminants and inspection dates. Reports follow quarterly state submissions and can lag by three to six months. Data follow state reports quarterly and can lag by three to six months. Counts describe the latest official quarter or the stated three- or five-year period, with no source history. A system is listed for every county it serves, so a large utility can appear under several counties. The counts cover every matched system, not only those returned. The list has at most `limit` systems, largest population served first. By default, only active community systems serving residents year round are included. Use `system_type: all` for schools, workplaces and rest stops with their own wells; use `include_inactive: true` to include inactive systems.",
|
|
775
|
+
"inputSchema": {
|
|
776
|
+
"type": "object",
|
|
777
|
+
"properties": {
|
|
778
|
+
"county_fips": {
|
|
779
|
+
"type": "string",
|
|
780
|
+
"description": "Five-digit state plus county code, the county_id returned by Place Resolve (place_resolve), for example 26049 for Genesee County, Michigan"
|
|
781
|
+
},
|
|
782
|
+
"system_type": {
|
|
783
|
+
"type": "string",
|
|
784
|
+
"enum": [
|
|
785
|
+
"community",
|
|
786
|
+
"non_transient_non_community",
|
|
787
|
+
"transient_non_community",
|
|
788
|
+
"all"
|
|
789
|
+
],
|
|
790
|
+
"description": "Community serves residents year round; non-transient non-community includes schools and workplaces; transient non-community includes rest stops and restaurants; all includes every type. Defaults to `\"community\"`."
|
|
791
|
+
},
|
|
792
|
+
"include_inactive": {
|
|
793
|
+
"type": "boolean",
|
|
794
|
+
"description": "Include inactive systems as well as active systems. Defaults to `false`."
|
|
795
|
+
},
|
|
796
|
+
"limit": {
|
|
797
|
+
"type": "integer",
|
|
798
|
+
"description": "How many systems to return, largest population first. From 1 to 25. Defaults to `10`."
|
|
799
|
+
}
|
|
800
|
+
},
|
|
801
|
+
"required": [
|
|
802
|
+
"county_fips"
|
|
803
|
+
]
|
|
804
|
+
},
|
|
805
|
+
"example": {
|
|
806
|
+
"county_fips": "26049",
|
|
807
|
+
"limit": 3
|
|
808
|
+
}
|
|
809
|
+
},
|
|
511
810
|
{
|
|
512
811
|
"name": "market_drug_acquisition_cost",
|
|
513
812
|
"path": "lookup/market-drug-acquisition-cost",
|
|
@@ -561,6 +860,65 @@ export const LOOKUP_MANIFEST = [
|
|
|
561
860
|
"limit": 3
|
|
562
861
|
}
|
|
563
862
|
},
|
|
863
|
+
{
|
|
864
|
+
"name": "product_drug_equivalents",
|
|
865
|
+
"path": "lookup/product-drug-equivalents",
|
|
866
|
+
"title": "Drug Equivalents",
|
|
867
|
+
"description": "Returns the US Food and Drug Administration’s therapeutic equivalence ratings from the Orange Book for a drug, by brand name or active ingredients: every approved product with the same ingredients, grouped by strength, dosage form and route, with its equivalence code, reference drug, marketing status, and exclusivity and patent expiry dates. Not medical or legal advice. A code starting with A rates equivalence to others in its group with the same code (AB1 only to AB1). B means not rated equivalent. Empty codes mean no rating, including single-source or discontinued products. Exclusivity and patent codes such as PED, NCE and PC are the Orange Book’s own and are not explained here. A brand resolves to full ingredient names; all brands and generics with those ingredients are returned, including other dosage forms. Discontinued products are excluded unless asked. For the product’s label use Drug Label. The source refreshes monthly; truncated indicates more records than the source returned.",
|
|
868
|
+
"inputSchema": {
|
|
869
|
+
"type": "object",
|
|
870
|
+
"properties": {
|
|
871
|
+
"brand_name": {
|
|
872
|
+
"type": "string",
|
|
873
|
+
"description": "Brand to resolve to its full ingredient names. 2 to 100 characters."
|
|
874
|
+
},
|
|
875
|
+
"ingredients": {
|
|
876
|
+
"type": "array",
|
|
877
|
+
"items": {
|
|
878
|
+
"type": "string"
|
|
879
|
+
},
|
|
880
|
+
"description": "Active ingredient names, each matched as a whole-word phrase"
|
|
881
|
+
},
|
|
882
|
+
"include_discontinued": {
|
|
883
|
+
"type": "boolean",
|
|
884
|
+
"description": "Include discontinued products. Defaults to `false`."
|
|
885
|
+
}
|
|
886
|
+
},
|
|
887
|
+
"required": []
|
|
888
|
+
},
|
|
889
|
+
"example": {
|
|
890
|
+
"ingredients": [
|
|
891
|
+
"apixaban"
|
|
892
|
+
]
|
|
893
|
+
}
|
|
894
|
+
},
|
|
895
|
+
{
|
|
896
|
+
"name": "product_drug_label",
|
|
897
|
+
"path": "lookup/product-drug-label",
|
|
898
|
+
"title": "Drug Label",
|
|
899
|
+
"description": "Returns a US drug product’s listing from the US Food and Drug Administration’s National Drug Code Directory, by NDC or name: ingredients and strengths, labeller, dosage form, route, marketing category and package codes. An NDC lookup adds key sections of the current label, each cut to 2,000 characters. Label text is the manufacturer’s, not medical advice. Give the dashed product or package NDC. A package NDC returns its whole product. Undashed billing NDCs cannot be converted without knowing which segment was padded. A name search returns products only; call again with an NDC for the label. Some listings have no linked label and return label: null. The label is the source’s current version, which can lag the listing. For prices use Drug Acquisition Cost; for equivalents use Drug Equivalents. The source says its unvalidated data must not guide medical care.",
|
|
900
|
+
"inputSchema": {
|
|
901
|
+
"type": "object",
|
|
902
|
+
"properties": {
|
|
903
|
+
"ndc": {
|
|
904
|
+
"type": "string",
|
|
905
|
+
"description": "Dashed product or package NDC, for example 70247-019 or 50580-449-10"
|
|
906
|
+
},
|
|
907
|
+
"name": {
|
|
908
|
+
"type": "string",
|
|
909
|
+
"description": "Brand or generic name, matched as a phrase. 2 to 100 characters."
|
|
910
|
+
},
|
|
911
|
+
"limit": {
|
|
912
|
+
"type": "integer",
|
|
913
|
+
"description": "Most products for a name search; ignored for NDC. From 1 to 10. Defaults to `5`."
|
|
914
|
+
}
|
|
915
|
+
},
|
|
916
|
+
"required": []
|
|
917
|
+
},
|
|
918
|
+
"example": {
|
|
919
|
+
"ndc": "70247-019"
|
|
920
|
+
}
|
|
921
|
+
},
|
|
564
922
|
{
|
|
565
923
|
"name": "product_drug_shortages",
|
|
566
924
|
"path": "lookup/product-drug-shortages",
|
|
@@ -675,16 +1033,101 @@ export const LOOKUP_MANIFEST = [
|
|
|
675
1033
|
}
|
|
676
1034
|
},
|
|
677
1035
|
{
|
|
678
|
-
"name": "
|
|
679
|
-
"path": "lookup/
|
|
680
|
-
"title": "
|
|
681
|
-
"description": "Returns
|
|
1036
|
+
"name": "product_energy_certification",
|
|
1037
|
+
"path": "lookup/product-energy-certification",
|
|
1038
|
+
"title": "Energy Efficiency Certification",
|
|
1039
|
+
"description": "Returns whether a product model is on the US Environmental Protection Agency’s current ENERGY STAR certified list, by category and brand, model number, UPC or ENERGY STAR ID, with the certification date, markets and the list’s published efficiency figures. all_categories searches every category but returns no figures. Delisted models are not shown. Supply at least one of brand, model_number, upc or energy_star_id. Brand and model number match as parts of the listed values; model numbers also match the additional model designations. Listed model numbers may use * for a variable character, so give the fixed leading part when an exact number does not match. Figures are the list’s own columns, so they differ by category. Not found means the model is not on the current list (never certified, or delisted), not that it failed a test. heat_pumps matches the outdoor unit’s brand. The lists refresh daily. The list shows certification status and is not an endorsement.",
|
|
682
1040
|
"inputSchema": {
|
|
683
1041
|
"type": "object",
|
|
684
1042
|
"properties": {
|
|
685
|
-
"
|
|
1043
|
+
"category": {
|
|
686
1044
|
"type": "string",
|
|
687
|
-
"
|
|
1045
|
+
"enum": [
|
|
1046
|
+
"refrigerators",
|
|
1047
|
+
"freezers",
|
|
1048
|
+
"dishwashers",
|
|
1049
|
+
"clothes_washers",
|
|
1050
|
+
"clothes_dryers",
|
|
1051
|
+
"combination_washer_dryers",
|
|
1052
|
+
"room_air_conditioners",
|
|
1053
|
+
"dehumidifiers",
|
|
1054
|
+
"room_air_cleaners",
|
|
1055
|
+
"electric_cooking_products",
|
|
1056
|
+
"televisions",
|
|
1057
|
+
"displays",
|
|
1058
|
+
"computers",
|
|
1059
|
+
"imaging_equipment",
|
|
1060
|
+
"telephones",
|
|
1061
|
+
"smart_thermostats",
|
|
1062
|
+
"ceiling_fans",
|
|
1063
|
+
"ventilating_fans",
|
|
1064
|
+
"downlights",
|
|
1065
|
+
"water_heaters",
|
|
1066
|
+
"heat_pumps",
|
|
1067
|
+
"geothermal_heat_pumps",
|
|
1068
|
+
"furnaces",
|
|
1069
|
+
"boilers",
|
|
1070
|
+
"pool_pumps",
|
|
1071
|
+
"ev_chargers",
|
|
1072
|
+
"storm_windows",
|
|
1073
|
+
"commercial_refrigerators_freezers",
|
|
1074
|
+
"commercial_dishwashers",
|
|
1075
|
+
"commercial_ice_machines",
|
|
1076
|
+
"commercial_ovens",
|
|
1077
|
+
"commercial_fryers",
|
|
1078
|
+
"commercial_griddles",
|
|
1079
|
+
"commercial_steam_cookers",
|
|
1080
|
+
"commercial_hot_food_holding_cabinets",
|
|
1081
|
+
"commercial_coffee_brewers",
|
|
1082
|
+
"water_coolers",
|
|
1083
|
+
"commercial_water_heaters",
|
|
1084
|
+
"commercial_boilers",
|
|
1085
|
+
"all_categories"
|
|
1086
|
+
],
|
|
1087
|
+
"description": "The product category; all_categories answers whether a model is certified in any category but returns no efficiency figures"
|
|
1088
|
+
},
|
|
1089
|
+
"brand": {
|
|
1090
|
+
"type": "string",
|
|
1091
|
+
"description": "The brand, matched case-insensitively as part of the listed brand name. 2 to 60 characters."
|
|
1092
|
+
},
|
|
1093
|
+
"model_number": {
|
|
1094
|
+
"type": "string",
|
|
1095
|
+
"description": "The model number, matched as part of the listed model number or additional model designations. Listed model numbers can use * for a variable character, so give the fixed leading part when an exact number does not match. 2 to 40 characters."
|
|
1096
|
+
},
|
|
1097
|
+
"upc": {
|
|
1098
|
+
"type": "string",
|
|
1099
|
+
"description": "A UPC, matched as part of the listed UPCs"
|
|
1100
|
+
},
|
|
1101
|
+
"energy_star_id": {
|
|
1102
|
+
"type": "string",
|
|
1103
|
+
"description": "The ENERGY STAR Unique ID"
|
|
1104
|
+
},
|
|
1105
|
+
"limit": {
|
|
1106
|
+
"type": "integer",
|
|
1107
|
+
"description": "The most models to return. From 1 to 25. Defaults to `10`."
|
|
1108
|
+
}
|
|
1109
|
+
},
|
|
1110
|
+
"required": [
|
|
1111
|
+
"category"
|
|
1112
|
+
]
|
|
1113
|
+
},
|
|
1114
|
+
"example": {
|
|
1115
|
+
"category": "televisions",
|
|
1116
|
+
"brand": "Samsung",
|
|
1117
|
+
"limit": 2
|
|
1118
|
+
}
|
|
1119
|
+
},
|
|
1120
|
+
{
|
|
1121
|
+
"name": "company_environmental_compliance",
|
|
1122
|
+
"path": "lookup/company-environmental-compliance",
|
|
1123
|
+
"title": "Environmental Compliance",
|
|
1124
|
+
"description": "Returns the federal environmental compliance record, from the US Environmental Protection Agency, of the facilities matching a company or facility name: compliance status, significant violations, quarters in violation, inspections, enforcement actions and penalties over five years. A match is by the words of the name, not verified ownership: tell facilities apart by address and registry id. Optionally narrow to one US state with `state`. For each facility: its address and registry id, its overall compliance status, whether it is currently a significant violator, how many of the last twelve quarters it was in violation, its inspections, formal enforcement actions and penalties over the last five years, and when it was last inspected and last penalised. The result also gives how many facilities matched in all and their penalties summed. Use it to check a supplier, a site or a counterparty against federal air, water, hazardous waste and drinking water programs. Covers US facilities regulated under federal environmental programs. The source matches every whole word of the name, in any order, against the current and alternate names a facility carries across its programs: a part of a word matches nothing, a search for Tesla also returns a facility on Tesla Road, and a facility matched under an alternate name may show a name without one of the words. The totals count every facility the search matched, not facilities verified to belong to the named company. `total_facilities` is 0 and `facilities` is empty when no facility name carries every word. A count or date is null when the source does not record it.",
|
|
1125
|
+
"inputSchema": {
|
|
1126
|
+
"type": "object",
|
|
1127
|
+
"properties": {
|
|
1128
|
+
"name": {
|
|
1129
|
+
"type": "string",
|
|
1130
|
+
"description": "Whole words of one facility name, in any order and without commas, for example TESLA MOTORS; a part of a word matches nothing. 3 to 100 characters. A name carries no comma: the source reads a comma as a separator between alternative names."
|
|
688
1131
|
},
|
|
689
1132
|
"state": {
|
|
690
1133
|
"type": "string",
|
|
@@ -709,6 +1152,57 @@ export const LOOKUP_MANIFEST = [
|
|
|
709
1152
|
"limit": 3
|
|
710
1153
|
}
|
|
711
1154
|
},
|
|
1155
|
+
{
|
|
1156
|
+
"name": "place_environmental_sites",
|
|
1157
|
+
"path": "lookup/place-environmental-sites",
|
|
1158
|
+
"title": "Environmental Sites",
|
|
1159
|
+
"description": "Returns environmental sites and compliance records from the US Environmental Protection Agency near a point or in a ZIP code or county. Includes facility counts, violations, five-year penalties and up to 25 facilities ordered by noncompliance, Superfund status or toxic releases and transfers. Brownfields are not covered. Each program count is a count of facilities; a facility can be in several programs. Superfund sites are listed but not counted in `by_program`: the source gives no Superfund total. Use `order: superfund` to bring Superfund sites first, or `order: toxic_releases` for the largest combined on-site releases and off-site transfers. Brownfields are not covered. A county search matches recorded county or coordinates, so a few facilities may be recorded under another county name. An area too large for one search is refused: use a point with a smaller radius or a ZIP code. Counts and total penalties cover every matched facility, including those beyond `limit`. Programs refresh weekly; current state and five-year enforcement counts are provided, with no source history.",
|
|
1160
|
+
"inputSchema": {
|
|
1161
|
+
"type": "object",
|
|
1162
|
+
"properties": {
|
|
1163
|
+
"latitude": {
|
|
1164
|
+
"type": "number",
|
|
1165
|
+
"description": "Point latitude in decimal degrees; give longitude too. From -90 to 90."
|
|
1166
|
+
},
|
|
1167
|
+
"longitude": {
|
|
1168
|
+
"type": "number",
|
|
1169
|
+
"description": "Point longitude in decimal degrees, west negative; give latitude too. From -180 to 180."
|
|
1170
|
+
},
|
|
1171
|
+
"radius_km": {
|
|
1172
|
+
"type": "number",
|
|
1173
|
+
"description": "Point search radius in kilometres, default 2; only with latitude and longitude. From 0.2 to 16."
|
|
1174
|
+
},
|
|
1175
|
+
"zip_code": {
|
|
1176
|
+
"type": "string",
|
|
1177
|
+
"description": "Five-digit facility ZIP code; placeholder ZIP codes 00000 and 99999 are refused"
|
|
1178
|
+
},
|
|
1179
|
+
"county_fips": {
|
|
1180
|
+
"type": "string",
|
|
1181
|
+
"description": "Five-digit state plus county code, the county_id returned by Place Resolve (place_resolve), for example 51059"
|
|
1182
|
+
},
|
|
1183
|
+
"order": {
|
|
1184
|
+
"type": "string",
|
|
1185
|
+
"enum": [
|
|
1186
|
+
"noncompliance",
|
|
1187
|
+
"superfund",
|
|
1188
|
+
"toxic_releases"
|
|
1189
|
+
],
|
|
1190
|
+
"description": "Most quarters in noncompliance, Superfund sites, or largest combined on-site toxic releases and off-site transfers first. Defaults to `\"noncompliance\"`."
|
|
1191
|
+
},
|
|
1192
|
+
"limit": {
|
|
1193
|
+
"type": "integer",
|
|
1194
|
+
"description": "How many facilities to return. From 1 to 25. Defaults to `10`."
|
|
1195
|
+
}
|
|
1196
|
+
},
|
|
1197
|
+
"required": []
|
|
1198
|
+
},
|
|
1199
|
+
"example": {
|
|
1200
|
+
"latitude": 43.08,
|
|
1201
|
+
"longitude": -78.95,
|
|
1202
|
+
"radius_km": 3,
|
|
1203
|
+
"limit": 3
|
|
1204
|
+
}
|
|
1205
|
+
},
|
|
712
1206
|
{
|
|
713
1207
|
"name": "company_fda_registration",
|
|
714
1208
|
"path": "lookup/company-fda-registration",
|
|
@@ -889,11 +1383,51 @@ export const LOOKUP_MANIFEST = [
|
|
|
889
1383
|
"limit": 1
|
|
890
1384
|
}
|
|
891
1385
|
},
|
|
1386
|
+
{
|
|
1387
|
+
"name": "place_flood_claims",
|
|
1388
|
+
"path": "lookup/place-flood-claims",
|
|
1389
|
+
"title": "Flood Insurance Claims",
|
|
1390
|
+
"description": "Lists National Flood Insurance Program claims for a US ZIP code, county or census tract, newest loss first, from the US Federal Emergency Management Agency's redacted claims: loss date, flood event, cause, flood zone, amounts paid and damage. Total counts every match and can exceed the page returned. Claims are redacted; locations are approximate. This product uses the Federal Emergency Management Agency's OpenFEMA data but is not endorsed by FEMA. The claims are redacted by FEMA; they must not be used to identify a policyholder. Give exactly one area. Optional loss_after and loss_before include both dates; limit defaults to 25, at most 100. No claims returns total: 0. Coordinates are rounded by FEMA to 0.1 degree and can fall in the wrong county. The source county code may not reflect the individual county where the property is located. Flood Zone gives the map designation; Disaster Declarations gives declarations, not insurance payouts. Policies and paid-amount totals are not included. Do not attempt to reidentify individuals or reverse engineer the source data.",
|
|
1391
|
+
"inputSchema": {
|
|
1392
|
+
"type": "object",
|
|
1393
|
+
"properties": {
|
|
1394
|
+
"zip_code": {
|
|
1395
|
+
"type": "string",
|
|
1396
|
+
"description": "Five-digit ZIP code"
|
|
1397
|
+
},
|
|
1398
|
+
"county_fips": {
|
|
1399
|
+
"type": "string",
|
|
1400
|
+
"description": "Five-digit county FIPS code"
|
|
1401
|
+
},
|
|
1402
|
+
"census_tract": {
|
|
1403
|
+
"type": "string",
|
|
1404
|
+
"description": "Eleven-digit census tract GEOID"
|
|
1405
|
+
},
|
|
1406
|
+
"loss_after": {
|
|
1407
|
+
"type": "string",
|
|
1408
|
+
"description": "Losses on or after this date, YYYY-MM-DD. Use YYYY-MM-DD."
|
|
1409
|
+
},
|
|
1410
|
+
"loss_before": {
|
|
1411
|
+
"type": "string",
|
|
1412
|
+
"description": "Losses on or before this date, YYYY-MM-DD. Use YYYY-MM-DD."
|
|
1413
|
+
},
|
|
1414
|
+
"limit": {
|
|
1415
|
+
"type": "integer",
|
|
1416
|
+
"description": "Most claims returned, newest loss first; default 25. From 1 to 100."
|
|
1417
|
+
}
|
|
1418
|
+
},
|
|
1419
|
+
"required": []
|
|
1420
|
+
},
|
|
1421
|
+
"example": {
|
|
1422
|
+
"zip_code": "23452",
|
|
1423
|
+
"limit": 2
|
|
1424
|
+
}
|
|
1425
|
+
},
|
|
892
1426
|
{
|
|
893
1427
|
"name": "place_flood_zone",
|
|
894
1428
|
"path": "lookup/place-flood-zone",
|
|
895
1429
|
"title": "Flood Zone",
|
|
896
|
-
"description": "Returns the flood hazard zone at a point from the flood hazard map of the US Federal Emergency Management Agency: the zone, its subtype, whether the point is in a special flood hazard area, the base flood elevation when stated and the map. This is a screening aid, not a flood determination: never base lending or insurance decisions on it. 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.",
|
|
1430
|
+
"description": "Returns the flood hazard zone at a point from the flood hazard map of the US Federal Emergency Management Agency: the zone, its subtype, whether the point is in a special flood hazard area, the base flood elevation when stated and the map. This is a screening aid, not a flood determination: never base lending or insurance decisions on it. This product uses the Federal Emergency Management Agency’s OpenFEMA API, but is not endorsed by FEMA. The Federal Government or FEMA cannot vouch for the data or analyses derived from these data after the data have been retrieved from the Agency's website(s). 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.",
|
|
897
1431
|
"inputSchema": {
|
|
898
1432
|
"type": "object",
|
|
899
1433
|
"properties": {
|
|
@@ -1261,6 +1795,92 @@ export const LOOKUP_MANIFEST = [
|
|
|
1261
1795
|
"limit": 1
|
|
1262
1796
|
}
|
|
1263
1797
|
},
|
|
1798
|
+
{
|
|
1799
|
+
"name": "place_hail_wind_reports",
|
|
1800
|
+
"path": "lookup/place-hail-wind-reports",
|
|
1801
|
+
"title": "Hail and Wind Reports",
|
|
1802
|
+
"description": "Lists the hail, damaging wind and tornado reports US National Weather Service offices filed in the last 24, 48 or 72 hours near a latitude and longitude or in a state, newest first: size or speed, time, place, office and remarks. Reports are preliminary and unverified and may repeat one event. Older reports are not kept; use Storm Events. Use it to check whether hail, a damaging gust or a tornado was reported near a property, a claim site or a route stop in the last day or three. Give a point (`latitude`, `longitude`, with `radius_km` 1 to 250, default 25) or a `state` (two-letter code), not both. `hours` is 24, 48 or 72 (default 24). `types` narrows to `hail`, `wind` or `tornado`; default all three. `magnitude` is hail size in inches or wind speed in mph (`magnitude_units` says which); damage and tornado reports carry no magnitude. `location` is the source's short place text, cut at 23 characters. `truncated` true means more reports matched than `limit`. A point or state with nothing reported is a completed result with `total` 0.",
|
|
1803
|
+
"inputSchema": {
|
|
1804
|
+
"type": "object",
|
|
1805
|
+
"properties": {
|
|
1806
|
+
"latitude": {
|
|
1807
|
+
"type": "number",
|
|
1808
|
+
"description": "Latitude in decimal degrees, for example 35.687. From 17 to 72."
|
|
1809
|
+
},
|
|
1810
|
+
"longitude": {
|
|
1811
|
+
"type": "number",
|
|
1812
|
+
"description": "Longitude in decimal degrees (west is negative), for example -105.938. From -180 to -64."
|
|
1813
|
+
},
|
|
1814
|
+
"radius_km": {
|
|
1815
|
+
"type": "number",
|
|
1816
|
+
"description": "Distance from the point in kilometres. From 1 to 250. Defaults to `25`."
|
|
1817
|
+
},
|
|
1818
|
+
"state": {
|
|
1819
|
+
"type": "string",
|
|
1820
|
+
"description": "Two-letter state code, for example NM. Two capital letters."
|
|
1821
|
+
},
|
|
1822
|
+
"hours": {
|
|
1823
|
+
"type": "integer",
|
|
1824
|
+
"description": "How far back to look: 24, 48 or 72. Defaults to `24`."
|
|
1825
|
+
},
|
|
1826
|
+
"types": {
|
|
1827
|
+
"type": "array",
|
|
1828
|
+
"items": {
|
|
1829
|
+
"type": "string",
|
|
1830
|
+
"enum": [
|
|
1831
|
+
"hail",
|
|
1832
|
+
"wind",
|
|
1833
|
+
"tornado"
|
|
1834
|
+
]
|
|
1835
|
+
},
|
|
1836
|
+
"description": "Report categories to return. Defaults to `[\"hail\",\"wind\",\"tornado\"]`."
|
|
1837
|
+
},
|
|
1838
|
+
"limit": {
|
|
1839
|
+
"type": "integer",
|
|
1840
|
+
"description": "Most reports to return. From 1 to 100. Defaults to `50`."
|
|
1841
|
+
}
|
|
1842
|
+
},
|
|
1843
|
+
"required": []
|
|
1844
|
+
},
|
|
1845
|
+
"example": {
|
|
1846
|
+
"latitude": 35.687,
|
|
1847
|
+
"longitude": -105.938,
|
|
1848
|
+
"radius_km": 25,
|
|
1849
|
+
"hours": 72,
|
|
1850
|
+
"limit": 2
|
|
1851
|
+
}
|
|
1852
|
+
},
|
|
1853
|
+
{
|
|
1854
|
+
"name": "place_hazard_risk",
|
|
1855
|
+
"path": "lookup/place-hazard-risk",
|
|
1856
|
+
"title": "Hazard Risk",
|
|
1857
|
+
"description": "Returns FEMA's National Risk Index for a US county or census tract, from the US Federal Emergency Management Agency: composite risk, expected annual loss, social vulnerability, community resilience and risk, loss and frequency for 18 natural hazards. Scores are national percentiles. For planning, not a local risk assessment. This product uses the Federal Emergency Management Agency's National Risk Index data but is not endorsed by FEMA, and FEMA cannot vouch for the data or analyses derived from it after retrieval. The index is for planning only and is not a substitute for a local risk assessment. Give exactly one county, tract or coordinate pair. A point answers for its 2020 census tract; Place Resolve gives coordinates for an address. Unknown areas return found: false. Flood Zone gives one hazard’s map at a point; Disaster Declarations lists past declared events. Annual frequency is events or event-days per year, as defined for each hazard by the index. Population is from 2020. Do not attempt to reidentify individuals or reverse engineer the source data.",
|
|
1858
|
+
"inputSchema": {
|
|
1859
|
+
"type": "object",
|
|
1860
|
+
"properties": {
|
|
1861
|
+
"county_fips": {
|
|
1862
|
+
"type": "string",
|
|
1863
|
+
"description": "Five-digit county FIPS code"
|
|
1864
|
+
},
|
|
1865
|
+
"census_tract": {
|
|
1866
|
+
"type": "string",
|
|
1867
|
+
"description": "Eleven-digit 2020 census tract GEOID"
|
|
1868
|
+
},
|
|
1869
|
+
"latitude": {
|
|
1870
|
+
"type": "number",
|
|
1871
|
+
"description": "Latitude in decimal degrees. From -90 to 90."
|
|
1872
|
+
},
|
|
1873
|
+
"longitude": {
|
|
1874
|
+
"type": "number",
|
|
1875
|
+
"description": "Longitude in decimal degrees. From -180 to 180."
|
|
1876
|
+
}
|
|
1877
|
+
},
|
|
1878
|
+
"required": []
|
|
1879
|
+
},
|
|
1880
|
+
"example": {
|
|
1881
|
+
"county_fips": "48201"
|
|
1882
|
+
}
|
|
1883
|
+
},
|
|
1264
1884
|
{
|
|
1265
1885
|
"name": "business_health_inspections",
|
|
1266
1886
|
"path": "lookup/business-health-inspections",
|
|
@@ -1379,6 +1999,98 @@ export const LOOKUP_MANIFEST = [
|
|
|
1379
1999
|
"npi": "1881018208"
|
|
1380
2000
|
}
|
|
1381
2001
|
},
|
|
2002
|
+
{
|
|
2003
|
+
"name": "place_home_price_index",
|
|
2004
|
+
"path": "lookup/place-home-price-index",
|
|
2005
|
+
"title": "Home Price Index",
|
|
2006
|
+
"description": "Returns the percent change over the latest quarter, one year, five years and since 1991 in the index of home values of the US Federal Housing Finance Agency, with its rank, for a US state, a metropolitan area by name, or a census division or the nation. It gives percent changes for the latest quarter, not prices or index levels. This product uses FHFA Data but is neither endorsed nor certified by FHFA. Give exactly one of `state`, `metro` or `division`. `metro` matches a substring of the source's metro name, case-insensitively; up to 10 matches are returned in rank order and `more` says whether others matched. The answer does not name the quarter; the source publishes it quarterly. State and division changes come from the purchase-only, seasonally adjusted index; metro changes from the all-transactions, not seasonally adjusted index. Rank 1 is the largest one-year rise among `ranked_among` areas. A value the source leaves blank (too few sales) is null. A metro matching nothing gives `found: false`.",
|
|
2007
|
+
"inputSchema": {
|
|
2008
|
+
"type": "object",
|
|
2009
|
+
"properties": {
|
|
2010
|
+
"state": {
|
|
2011
|
+
"type": "string",
|
|
2012
|
+
"enum": [
|
|
2013
|
+
"AL",
|
|
2014
|
+
"AK",
|
|
2015
|
+
"AZ",
|
|
2016
|
+
"AR",
|
|
2017
|
+
"CA",
|
|
2018
|
+
"CO",
|
|
2019
|
+
"CT",
|
|
2020
|
+
"DE",
|
|
2021
|
+
"DC",
|
|
2022
|
+
"FL",
|
|
2023
|
+
"GA",
|
|
2024
|
+
"HI",
|
|
2025
|
+
"ID",
|
|
2026
|
+
"IL",
|
|
2027
|
+
"IN",
|
|
2028
|
+
"IA",
|
|
2029
|
+
"KS",
|
|
2030
|
+
"KY",
|
|
2031
|
+
"LA",
|
|
2032
|
+
"ME",
|
|
2033
|
+
"MD",
|
|
2034
|
+
"MA",
|
|
2035
|
+
"MI",
|
|
2036
|
+
"MN",
|
|
2037
|
+
"MS",
|
|
2038
|
+
"MO",
|
|
2039
|
+
"MT",
|
|
2040
|
+
"NE",
|
|
2041
|
+
"NV",
|
|
2042
|
+
"NH",
|
|
2043
|
+
"NJ",
|
|
2044
|
+
"NM",
|
|
2045
|
+
"NY",
|
|
2046
|
+
"NC",
|
|
2047
|
+
"ND",
|
|
2048
|
+
"OH",
|
|
2049
|
+
"OK",
|
|
2050
|
+
"OR",
|
|
2051
|
+
"PA",
|
|
2052
|
+
"RI",
|
|
2053
|
+
"SC",
|
|
2054
|
+
"SD",
|
|
2055
|
+
"TN",
|
|
2056
|
+
"TX",
|
|
2057
|
+
"UT",
|
|
2058
|
+
"VT",
|
|
2059
|
+
"VA",
|
|
2060
|
+
"WA",
|
|
2061
|
+
"WV",
|
|
2062
|
+
"WI",
|
|
2063
|
+
"WY"
|
|
2064
|
+
],
|
|
2065
|
+
"description": "A two-letter US state code, or DC, for example MI"
|
|
2066
|
+
},
|
|
2067
|
+
"metro": {
|
|
2068
|
+
"type": "string",
|
|
2069
|
+
"description": "Words of a metropolitan area name, for example Detroit or Ann Arbor. 2 to 80 characters."
|
|
2070
|
+
},
|
|
2071
|
+
"division": {
|
|
2072
|
+
"type": "string",
|
|
2073
|
+
"enum": [
|
|
2074
|
+
"united_states",
|
|
2075
|
+
"new_england",
|
|
2076
|
+
"middle_atlantic",
|
|
2077
|
+
"east_north_central",
|
|
2078
|
+
"west_north_central",
|
|
2079
|
+
"south_atlantic",
|
|
2080
|
+
"east_south_central",
|
|
2081
|
+
"west_south_central",
|
|
2082
|
+
"mountain",
|
|
2083
|
+
"pacific"
|
|
2084
|
+
],
|
|
2085
|
+
"description": "A US census division, or united_states for the nation"
|
|
2086
|
+
}
|
|
2087
|
+
},
|
|
2088
|
+
"required": []
|
|
2089
|
+
},
|
|
2090
|
+
"example": {
|
|
2091
|
+
"state": "MI"
|
|
2092
|
+
}
|
|
2093
|
+
},
|
|
1382
2094
|
{
|
|
1383
2095
|
"name": "place_hospitals",
|
|
1384
2096
|
"path": "lookup/place-hospitals",
|
|
@@ -1448,6 +2160,56 @@ export const LOOKUP_MANIFEST = [
|
|
|
1448
2160
|
"end_date": "2026-10-16"
|
|
1449
2161
|
}
|
|
1450
2162
|
},
|
|
2163
|
+
{
|
|
2164
|
+
"name": "place_jobs_wages",
|
|
2165
|
+
"path": "lookup/place-jobs-wages",
|
|
2166
|
+
"title": "Jobs and Wages",
|
|
2167
|
+
"description": "Returns, for a US county, state or the nation, the quarterly number of establishments, monthly employment, total wages and average weekly wage, and the average annual pay by year, from the Quarterly Census of Employment and Wages of the US Bureau of Labor Statistics. It covers jobs covered by unemployment insurance only, and the newest quarter is preliminary. BLS.gov cannot vouch for the data or analyses derived from these data after the data have been retrieved from BLS.gov. The source returns the last three calendar years; `quarters` and `annual_pay` are newest first. A value the source leaves blank is null. `total_wages_thousands` is in thousands of dollars, as published. An area, ownership or industry the source has no series for gives `found: false` and empty lists. Industry figures are published per ownership: a supersector with ownership `total` is refused. The source allows 25 keyless queries a day per address, shared by every caller.",
|
|
2168
|
+
"inputSchema": {
|
|
2169
|
+
"type": "object",
|
|
2170
|
+
"properties": {
|
|
2171
|
+
"area_fips": {
|
|
2172
|
+
"type": "string",
|
|
2173
|
+
"description": "The area: a five-digit county FIPS code (26163 is Wayne County, Michigan), a two-digit state FIPS code followed by 000 (26000), or US000 for the nation. Place Resolve gives the county code of an address as `county_id`. area_fips is a five-digit county FIPS code, a state FIPS code followed by 000, or US000."
|
|
2174
|
+
},
|
|
2175
|
+
"ownership": {
|
|
2176
|
+
"type": "string",
|
|
2177
|
+
"enum": [
|
|
2178
|
+
"total",
|
|
2179
|
+
"private",
|
|
2180
|
+
"federal_government",
|
|
2181
|
+
"state_government",
|
|
2182
|
+
"local_government"
|
|
2183
|
+
],
|
|
2184
|
+
"description": "Who employs: all owners, private employers, or federal, state or local government. Defaults to `\"total\"`."
|
|
2185
|
+
},
|
|
2186
|
+
"industry": {
|
|
2187
|
+
"type": "string",
|
|
2188
|
+
"enum": [
|
|
2189
|
+
"all",
|
|
2190
|
+
"natural_resources_and_mining",
|
|
2191
|
+
"construction",
|
|
2192
|
+
"manufacturing",
|
|
2193
|
+
"trade_transportation_and_utilities",
|
|
2194
|
+
"information",
|
|
2195
|
+
"financial_activities",
|
|
2196
|
+
"professional_and_business_services",
|
|
2197
|
+
"education_and_health_services",
|
|
2198
|
+
"leisure_and_hospitality",
|
|
2199
|
+
"other_services",
|
|
2200
|
+
"public_administration"
|
|
2201
|
+
],
|
|
2202
|
+
"description": "The industry supersector, or all industries. Defaults to `\"all\"`."
|
|
2203
|
+
}
|
|
2204
|
+
},
|
|
2205
|
+
"required": [
|
|
2206
|
+
"area_fips"
|
|
2207
|
+
]
|
|
2208
|
+
},
|
|
2209
|
+
"example": {
|
|
2210
|
+
"area_fips": "26163"
|
|
2211
|
+
}
|
|
2212
|
+
},
|
|
1451
2213
|
{
|
|
1452
2214
|
"name": "company_legal_identifier",
|
|
1453
2215
|
"path": "lookup/company-legal-identifier",
|
|
@@ -1688,6 +2450,91 @@ export const LOOKUP_MANIFEST = [
|
|
|
1688
2450
|
"dot_number": "44110"
|
|
1689
2451
|
}
|
|
1690
2452
|
},
|
|
2453
|
+
{
|
|
2454
|
+
"name": "company_nonprofit_status",
|
|
2455
|
+
"path": "lookup/company-nonprofit-status",
|
|
2456
|
+
"title": "Nonprofit Status",
|
|
2457
|
+
"description": "Returns organizations in the US Internal Revenue Service's Tax Exempt Organization Search matching an EIN or name: whether each is listed as eligible for tax-deductible contributions, any automatic revocation of its exemption and reinstatement, its Form 990-N filings, and its filed annual returns with links to the public copies. Figures from the returns are in those copies, not here. Give exactly one of `ein` and `name`; `state` narrows a name search only. An EIN returns `profile`, the organization's full record, with `total` 1; `profile` is null and `total` 0 when the EIN is in none of the source's lists. A name returns `matches`, a list of organizations to pick from, alphabetical, each with the EIN to call again with; `profile` is then null. Listed in `publication_78` means the organization is eligible to receive tax-deductible contributions. An organization absent from every list may still be exempt: churches need not apply, and the exempt organizations master file is not searched here. A row in `revocations` does not mean the organization is still revoked: it may have been reinstated, so check `reinstated_on`. `exemption_subsection` is the section 501(c) subsection the exemption was under, for example 03 for a 501(c)(3). `form_990n_filings` keeps the newest five filings and `returns` the newest ten, newest first; each return has the form, the period it covers and a link to its public copy. Officer names and addresses are never returned. Dates are YYYY-MM-DD; one the source writes in an unreadable form is null.",
|
|
2458
|
+
"inputSchema": {
|
|
2459
|
+
"type": "object",
|
|
2460
|
+
"properties": {
|
|
2461
|
+
"ein": {
|
|
2462
|
+
"type": "string",
|
|
2463
|
+
"description": "The employer identification number, for example 53-0196605 or 530196605. An exact match that returns the full profile. An EIN is nine digits, with or without the dash."
|
|
2464
|
+
},
|
|
2465
|
+
"name": {
|
|
2466
|
+
"type": "string",
|
|
2467
|
+
"description": "The organization's name, for example American Red Cross. A text match; returns a list to pick from. 2 to 100 characters."
|
|
2468
|
+
},
|
|
2469
|
+
"state": {
|
|
2470
|
+
"type": "string",
|
|
2471
|
+
"description": "Two-letter state code to narrow a name search; only with `name`. A two-letter state code."
|
|
2472
|
+
},
|
|
2473
|
+
"limit": {
|
|
2474
|
+
"type": "integer",
|
|
2475
|
+
"description": "Most organizations to return for a name; ignored with an EIN. From 1 to 25. Defaults to `10`."
|
|
2476
|
+
},
|
|
2477
|
+
"fresh": {
|
|
2478
|
+
"type": "boolean",
|
|
2479
|
+
"description": "Look the record up again instead of using OneShot's stored copy from an earlier lookup, and refresh that copy. Off by default: a record stored within its freshness window is returned as is, with cached: true and its fetched_at."
|
|
2480
|
+
}
|
|
2481
|
+
},
|
|
2482
|
+
"required": []
|
|
2483
|
+
},
|
|
2484
|
+
"example": {
|
|
2485
|
+
"ein": "530196605"
|
|
2486
|
+
}
|
|
2487
|
+
},
|
|
2488
|
+
{
|
|
2489
|
+
"name": "place_opportunity_zone",
|
|
2490
|
+
"path": "lookup/place-opportunity-zone",
|
|
2491
|
+
"title": "Opportunity Zone",
|
|
2492
|
+
"description": "Says whether a US census tract or point is in a Qualified Opportunity Zone designated by the US Department of the Treasury in 2018, as published by the US Department of Housing and Urban Development, with tract, state, county and rural flag. Tracts are from 2010. The 2027 designation round is not included. Give exactly one 2010 census tract GEOID or coordinate pair. A point answers for its 2010 tract; 2020 census tract ids can differ. A point outside every designated zone, including outside the United States, returns designated: false. Place Resolve gives coordinates for an address. Rural means identified as a rural census tract according to the US Treasury. This is not tax advice. HUD and the dataset and metadata authors assume no responsibility for the use or misuse of the dataset.",
|
|
2493
|
+
"inputSchema": {
|
|
2494
|
+
"type": "object",
|
|
2495
|
+
"properties": {
|
|
2496
|
+
"census_tract": {
|
|
2497
|
+
"type": "string",
|
|
2498
|
+
"description": "Eleven-digit 2010 census tract GEOID"
|
|
2499
|
+
},
|
|
2500
|
+
"latitude": {
|
|
2501
|
+
"type": "number",
|
|
2502
|
+
"description": "Latitude in decimal degrees. From -90 to 90."
|
|
2503
|
+
},
|
|
2504
|
+
"longitude": {
|
|
2505
|
+
"type": "number",
|
|
2506
|
+
"description": "Longitude in decimal degrees. From -180 to 180."
|
|
2507
|
+
}
|
|
2508
|
+
},
|
|
2509
|
+
"required": []
|
|
2510
|
+
},
|
|
2511
|
+
"example": {
|
|
2512
|
+
"census_tract": "48201532800"
|
|
2513
|
+
}
|
|
2514
|
+
},
|
|
2515
|
+
{
|
|
2516
|
+
"name": "organism_resolve",
|
|
2517
|
+
"path": "resolve/organism",
|
|
2518
|
+
"title": "Organism Identity",
|
|
2519
|
+
"description": "Resolves a scientific name, common name or recorded misspelling, or an NCBI Taxonomy ID, to the matching organisms in the Taxonomy database of the US National Center for Biotechnology Information: taxonomy ID, scientific name, common name, rank, division, the lineage from the root down and whether the ID sent is still current. NCBI's Disclaimer (https://www.ncbi.nlm.nih.gov/home/about/policies/#disclaimer) and Copyright notice (https://www.ncbi.nlm.nih.gov/home/about/policies/#copyright) apply to these records: the US Government does not warrant or assume any legal liability or responsibility for their accuracy, completeness or usefulness, and NCBI does not endorse or recommend any commercial products, processes or services. Give exactly one of `name` or `taxonomy_id`. `name` matches every name the source keeps for an organism, including common names and the misspellings it records, so `Home sapiens` resolves to Homo sapiens. The whole name must match; it is not a word search. A name shared by more than one organism (mouse is both the species Mus musculus and the genus Mus) returns each, up to 10, in the source's order, with `ambiguous` true. A retired taxonomy ID returns the record it was merged into, with `active` false. An unknown name or taxonomy ID returns an empty matches list. The NCBI Taxonomy ID is the `taxon_id` input of Gene Resolve.",
|
|
2520
|
+
"inputSchema": {
|
|
2521
|
+
"type": "object",
|
|
2522
|
+
"properties": {
|
|
2523
|
+
"name": {
|
|
2524
|
+
"type": "string",
|
|
2525
|
+
"description": "A scientific name (Homo sapiens), common name (human) or misspelling the source records; give exactly one of name or taxonomy_id. 2 to 200 characters. No double quotes, brackets or control characters."
|
|
2526
|
+
},
|
|
2527
|
+
"taxonomy_id": {
|
|
2528
|
+
"type": "integer",
|
|
2529
|
+
"description": "An NCBI Taxonomy ID, for example 9606; give exactly one of name or taxonomy_id. From 1 to 999999999."
|
|
2530
|
+
}
|
|
2531
|
+
},
|
|
2532
|
+
"required": []
|
|
2533
|
+
},
|
|
2534
|
+
"example": {
|
|
2535
|
+
"name": "Escherichia coli"
|
|
2536
|
+
}
|
|
2537
|
+
},
|
|
1691
2538
|
{
|
|
1692
2539
|
"name": "place_resolve",
|
|
1693
2540
|
"path": "resolve/place",
|
|
@@ -2008,15 +2855,137 @@ export const LOOKUP_MANIFEST = [
|
|
|
2008
2855
|
}
|
|
2009
2856
|
},
|
|
2010
2857
|
{
|
|
2011
|
-
"name": "
|
|
2012
|
-
"path": "lookup/
|
|
2013
|
-
"title": "
|
|
2014
|
-
"description": "
|
|
2858
|
+
"name": "place_radar_imagery",
|
|
2859
|
+
"path": "lookup/place-radar-imagery",
|
|
2860
|
+
"title": "Radar Imagery",
|
|
2861
|
+
"description": "Lists radar scenes newest first. Radar shows surface roughness and water, not colour; flood extent and ships stand out, but interpretation is the agent's job. Coverage counts acquisitions, not detected objects. An empty scene list means no recorded pass, so no evidence either way. Derived entries explain computed fields; other scene fields are observed. Contains Copernicus Sentinel-1 data under the Copernicus Sentinel Data licence. Credit: Copernicus and ESA; archive served by Alaska Satellite Facility. Sentinel-1 covers most land every 6 to 12 days; cloud and darkness do not prevent radar imaging. An acquisition does not prove visibility of every feature within its footprint. Give latitude and longitude or bbox, not both. Boxes must be at most 1 degree a side. since defaults to 30 days ago and may be at most 1 year back; limit defaults to 5, maximum 25. One search fetches at most limit plus one scenes. total counts that page, including the withheld extra scene, and is a lower bound when truncated is true. coverage.complete is false then. coverage.since and until are inclusive UTC dates. observed.scenes preserves the source metadata for every considered scene. latest, coverage, total, returned and truncated have provenance under derived. Each listed scene also explains its lowercase flight_direction and constructed scene_url under derived; observed.flight_direction preserves the source spelling. relative_orbit is ASF pathNumber, not the absolute orbit number. browse_url is a public JPEG checked without credentials during the build; null if the source supplies no verified public link. scene_url opens the ASF catalogue. Full-resolution downloads may need an Earthdata login. coverage.catalogue_available is true when the catalogue returned a valid response. An empty scenes list then means no matching acquisition in the requested window, never evidence of absence of floods, ships or other features. An unreachable catalogue, HTTP error or invalid response fails with a typed error instead of returning an empty result. This tool does not classify imagery.",
|
|
2015
2862
|
"inputSchema": {
|
|
2016
2863
|
"type": "object",
|
|
2017
2864
|
"properties": {
|
|
2018
|
-
"
|
|
2019
|
-
"type": "
|
|
2865
|
+
"latitude": {
|
|
2866
|
+
"type": "number",
|
|
2867
|
+
"description": "Latitude in decimal degrees; supply longitude too. From -90 to 90."
|
|
2868
|
+
},
|
|
2869
|
+
"longitude": {
|
|
2870
|
+
"type": "number",
|
|
2871
|
+
"description": "Longitude in decimal degrees. From -180 to 180."
|
|
2872
|
+
},
|
|
2873
|
+
"bbox": {
|
|
2874
|
+
"type": "array",
|
|
2875
|
+
"items": {
|
|
2876
|
+
"type": "number"
|
|
2877
|
+
},
|
|
2878
|
+
"description": "[west, south, east, north], at most 1 degree a side; instead of a point"
|
|
2879
|
+
},
|
|
2880
|
+
"since": {
|
|
2881
|
+
"type": "string",
|
|
2882
|
+
"description": "First UTC date, YYYY-MM-DD; defaults to 30 days ago, at most 1 year back"
|
|
2883
|
+
},
|
|
2884
|
+
"limit": {
|
|
2885
|
+
"type": "integer",
|
|
2886
|
+
"description": "Most scenes to return; default 5, maximum 25. From 1 to 25. Defaults to `5`."
|
|
2887
|
+
}
|
|
2888
|
+
},
|
|
2889
|
+
"required": []
|
|
2890
|
+
},
|
|
2891
|
+
"example": {
|
|
2892
|
+
"latitude": 34.05,
|
|
2893
|
+
"longitude": -118.25
|
|
2894
|
+
}
|
|
2895
|
+
},
|
|
2896
|
+
{
|
|
2897
|
+
"name": "place_recent_imagery",
|
|
2898
|
+
"path": "lookup/place-recent-imagery",
|
|
2899
|
+
"title": "Recent Imagery",
|
|
2900
|
+
"description": "Lists the Harmonized Landsat Sentinel-2 scenes NASA catalogued over a point or box since a date, newest first, at or under a cloud cover. Scene fields are observed; only latest is derived. Empty scenes with coverage.scenes_considered above zero means looked and nothing clear, scenes_too_cloudy and scenes_cloud_unknown say why; zero means no pass. coverage.complete false makes every count a lower bound. Landsat imagery courtesy of the US Geological Survey and NASA, public domain. Sentinel-2 imagery contains modified Copernicus Sentinel data, under the Copernicus Sentinel Data licence. Browse images are served by NASA LP DAAC and NASA GIBS. Scenes are 30 m; each product passes every 2 to 3 days. Open ocean and the poles are not imaged. derived.latest names its rule and the fields it reads. Give latitude and longitude, or bbox as [west, south, east, north] in decimal degrees at most 1 degree a side; not both. since (YYYY-MM-DD, UTC) defaults to 30 days before the call and may be at most 1 year back. max_cloud_pct (0 to 100) defaults to 20. limit defaults to 5, at most 25. coverage.scenes_considered counts every examined pass whatever its cloud; scenes_too_cloudy those above max_cloud_pct; scenes_cloud_unknown those the source gave no cloud figure for, which are never listed as clear. coverage.scenes_in_window is the catalogue's own count of passes in the window. When scenes_considered is zero the sensor had no pass: an empty list is then no evidence either way. At most the newest 200 passes per product are examined. coverage.complete is true when that is every pass in the window, so the counts and total are exact; false when older passes were left unexamined, so scenes_considered, scenes_too_cloudy, scenes_cloud_unknown and total are lower bounds and truncated is true. truncated is also true when clear scenes beyond limit were left out. A landsat browse_url is the granule browse JPEG. Sentinel-2 granules carry none, so their browse_url is a GIBS Worldview snapshot of the HLS Sentinel-2 layer over the scene footprint on the acquisition day: a daily composite, not the single granule. cloud_pct is the whole-scene figure the source reported; a clear scene may still have cloud over the exact point.",
|
|
2901
|
+
"inputSchema": {
|
|
2902
|
+
"type": "object",
|
|
2903
|
+
"properties": {
|
|
2904
|
+
"latitude": {
|
|
2905
|
+
"type": "number",
|
|
2906
|
+
"description": "Latitude in decimal degrees; give longitude too. From -90 to 90."
|
|
2907
|
+
},
|
|
2908
|
+
"longitude": {
|
|
2909
|
+
"type": "number",
|
|
2910
|
+
"description": "Longitude in decimal degrees; west is negative. From -180 to 180."
|
|
2911
|
+
},
|
|
2912
|
+
"bbox": {
|
|
2913
|
+
"type": "array",
|
|
2914
|
+
"items": {
|
|
2915
|
+
"type": "number"
|
|
2916
|
+
},
|
|
2917
|
+
"description": "[west, south, east, north] in decimal degrees, at most 1 degree a side; instead of a point"
|
|
2918
|
+
},
|
|
2919
|
+
"max_cloud_pct": {
|
|
2920
|
+
"type": "number",
|
|
2921
|
+
"description": "Highest scene cloud cover to list, in percent; fractions such as 20.5 are allowed. From 0 to 100. Defaults to `20`."
|
|
2922
|
+
},
|
|
2923
|
+
"since": {
|
|
2924
|
+
"type": "string",
|
|
2925
|
+
"description": "Earliest acquisition date (UTC); default 30 days before the call, at most 1 year back. Use YYYY-MM-DD."
|
|
2926
|
+
},
|
|
2927
|
+
"limit": {
|
|
2928
|
+
"type": "integer",
|
|
2929
|
+
"description": "Most scenes to return. From 1 to 25. Defaults to `5`."
|
|
2930
|
+
}
|
|
2931
|
+
},
|
|
2932
|
+
"required": []
|
|
2933
|
+
},
|
|
2934
|
+
"example": {
|
|
2935
|
+
"latitude": 34.05,
|
|
2936
|
+
"longitude": -118.25,
|
|
2937
|
+
"limit": 2
|
|
2938
|
+
}
|
|
2939
|
+
},
|
|
2940
|
+
{
|
|
2941
|
+
"name": "record_dockets_find",
|
|
2942
|
+
"path": "find/record-dockets",
|
|
2943
|
+
"title": "Regulatory Dockets",
|
|
2944
|
+
"description": "Searches the dockets of US federal agencies on the federal regulations portal, newest change first: docket id, agency, type (rulemaking or nonrulemaking), title, the date of its last change and a link. A docket is the file a rule or notice and its public comments sit in; this returns the dockets, not the documents or comments inside them. Optionally narrow by `agency` (its acronym, for example FAA or EPA) and by `docket_type` (rulemaking or nonrulemaking). Use it to find where an agency keeps the record of a rule and its public comments; use the Federal Register documents tool for the published rules and notices themselves. `total` is how many dockets matched, including any beyond `limit`, and is 0 when none did. Each docket links to its page on the portal, which lists its documents and comments.",
|
|
2945
|
+
"inputSchema": {
|
|
2946
|
+
"type": "object",
|
|
2947
|
+
"properties": {
|
|
2948
|
+
"query": {
|
|
2949
|
+
"type": "string",
|
|
2950
|
+
"description": "Search words, for example unmanned aircraft. 2 to 200 characters."
|
|
2951
|
+
},
|
|
2952
|
+
"agency": {
|
|
2953
|
+
"type": "string",
|
|
2954
|
+
"description": "Only dockets of this agency, as its acronym, for example FAA or EPA. 2 to 10 characters. Use the agency acronym, letters and digits only."
|
|
2955
|
+
},
|
|
2956
|
+
"docket_type": {
|
|
2957
|
+
"type": "string",
|
|
2958
|
+
"enum": [
|
|
2959
|
+
"rulemaking",
|
|
2960
|
+
"nonrulemaking"
|
|
2961
|
+
],
|
|
2962
|
+
"description": "Only dockets of this kind"
|
|
2963
|
+
},
|
|
2964
|
+
"limit": {
|
|
2965
|
+
"type": "integer",
|
|
2966
|
+
"description": "The most dockets to return. From 1 to 25. Defaults to `10`."
|
|
2967
|
+
}
|
|
2968
|
+
},
|
|
2969
|
+
"required": [
|
|
2970
|
+
"query"
|
|
2971
|
+
]
|
|
2972
|
+
},
|
|
2973
|
+
"example": {
|
|
2974
|
+
"query": "unmanned aircraft",
|
|
2975
|
+
"agency": "FAA",
|
|
2976
|
+
"limit": 2
|
|
2977
|
+
}
|
|
2978
|
+
},
|
|
2979
|
+
{
|
|
2980
|
+
"name": "company_financials",
|
|
2981
|
+
"path": "lookup/company-financials",
|
|
2982
|
+
"title": "Reported Financials",
|
|
2983
|
+
"description": "Returns one reported financial figure of a US public company, by Central Index Key (CIK), from its filings with the US Securities and Exchange Commission: one value per period, newest first, with dates, fiscal period, form, filing date and accession number. Figures are as the company reported them; a later filing that restates a period replaces the earlier value. The CIK is the registrant number the US Securities and Exchange Commission assigns to every filer, as for Company Filings. Looks up by identifier only: it does not search by company name or ticker. `metric` is one of `revenue`, `net_income`, `operating_income`, `total_assets`, `total_liabilities`, `stockholders_equity`, `cash` or `eps_diluted`; `period` is `annual` (default) or `quarterly`. Returns the company name, the US GAAP tag and unit the figures come from, and each value's calendar frame, start and end dates, fiscal year and period. Figures are not adjusted or restated by anyone else. `periods` is empty when the company never reported the metric under its US GAAP tag. History is kept per series: Changes addresses one by the padded identifier, metric and period joined with colons (`0000320193:revenue:annual`); a call with a non-default `limit` is kept as a query.",
|
|
2984
|
+
"inputSchema": {
|
|
2985
|
+
"type": "object",
|
|
2986
|
+
"properties": {
|
|
2987
|
+
"cik": {
|
|
2988
|
+
"type": "string",
|
|
2020
2989
|
"description": "The registry identifier (CIK), for example 320193. Shorter numbers are padded with zeros. A CIK is 1 to 10 digits."
|
|
2021
2990
|
},
|
|
2022
2991
|
"metric": {
|
|
@@ -2061,6 +3030,353 @@ export const LOOKUP_MANIFEST = [
|
|
|
2061
3030
|
"limit": 2
|
|
2062
3031
|
}
|
|
2063
3032
|
},
|
|
3033
|
+
{
|
|
3034
|
+
"name": "place_satellite_passes",
|
|
3035
|
+
"path": "lookup/place-satellite-passes",
|
|
3036
|
+
"title": "Satellite Passes",
|
|
3037
|
+
"description": "Lists when imaging satellites were or will be over a point; only published orbits are covered. observed is the satellite and orbit the source published; every pass figure is derived by SGP4 (rise_at, culminate_at, set_at, max_elevation_deg, daynight, cut_by_window, track_distance_km, in_swath). in_swath true means the sensor could have seen the point; it does not mean an image was taken or released. Orbital elements courtesy of CelesTrak (celestrak.org), from US government sources. The pass times are computed by OneShot, not published by CelesTrak. Nothing in a pass is measured. observed is what the source published about the satellite and its orbit; every time and figure under derived is computed from that orbit by SGP4 and carries value, rule and from. Accuracy falls with distance from the element epoch, so a pass more than 3 days from its epoch is left out and counted in coverage.too_far_from_epoch. daynight is day when the Sun is above the horizon at the point at culmination. derived.track_distance_km is the least distance from the point to the ground track anywhere in the pass as reported, to 0.1 km. derived.in_swath compares that distance, before rounding, with half the sensor swath from a fixed table: VIIRS (Suomi NPP, NOAA-20, NOAA-21) 3,000 km, MODIS (Terra, Aqua) 2,330 km, Landsat 8 and 9 OLI 185 km, Sentinel-2A, 2B and 2C MSI 290 km, Sentinel-1A, 1C and 1D IW 250 km. It is null for an imaging satellite whose swath is not in the table, such as WorldView-3 or Sentinel-3A: the pass is reported, whether the point was in its swath is not known. Reading coverage: coverage.satellites lists each satellite considered with its element epoch and, when tabled, its sensor and swath. Empty passes with satellites listed and too_far_from_epoch zero means the orbits were computed and none rose above min_elevation_deg: looked, saw nothing. Empty passes with coverage.satellites empty, or with every pass in too_far_from_epoch, means no evidence either way. coverage.not_published lists swath-table satellites the source did not list. from and to are ISO 8601 UTC (a date alone is midnight UTC), at most 48 hours apart and within 3 days of the call either way; defaults are 24 hours before and after the call. A pass in progress at from or at to is cut at the window edge and marked cut_by_window. min_elevation_deg defaults to 10. limit defaults to 25, at most 200; total, returned and truncated report the list. kind imaging (default) considers every satellite below geosynchronous orbit in the Earth resources and weather catalogues and the Sentinel-1 family, the 12-hour Molniya orbit of ARKTIKA-M included, except the missions that carry no imager (altimeters, GNSS reflectometry and occultation constellations, ionosphere probes, data relays); kind all considers those too. Geosynchronous and higher orbits do not pass over a point and are counted in coverage.high_orbit_left_out. Imaging satellites whose orbits are not published are not in the source. Three catalogue reads per call, kept in this process for 2 hours as the source asks and shared by every caller in that time, a fresh call included; evidence.calls carry the time the element sets were fetched.",
|
|
3038
|
+
"inputSchema": {
|
|
3039
|
+
"type": "object",
|
|
3040
|
+
"properties": {
|
|
3041
|
+
"latitude": {
|
|
3042
|
+
"type": "number",
|
|
3043
|
+
"description": "Latitude in decimal degrees, for example 34.05. From -90 to 90."
|
|
3044
|
+
},
|
|
3045
|
+
"longitude": {
|
|
3046
|
+
"type": "number",
|
|
3047
|
+
"description": "Longitude in decimal degrees (west is negative), for example -118.25. From -180 to 180."
|
|
3048
|
+
},
|
|
3049
|
+
"from": {
|
|
3050
|
+
"type": "string",
|
|
3051
|
+
"description": "Start of the window, ISO 8601 UTC such as 2026-10-28T00:00:00Z or 2026-10-28; default 24 hours before the call"
|
|
3052
|
+
},
|
|
3053
|
+
"to": {
|
|
3054
|
+
"type": "string",
|
|
3055
|
+
"description": "End of the window, ISO 8601 UTC, at most 48 hours after from and within 3 days of the call; default 24 hours after the call"
|
|
3056
|
+
},
|
|
3057
|
+
"kind": {
|
|
3058
|
+
"type": "string",
|
|
3059
|
+
"enum": [
|
|
3060
|
+
"imaging",
|
|
3061
|
+
"all"
|
|
3062
|
+
],
|
|
3063
|
+
"description": "imaging: every satellite below geosynchronous orbit in the catalogues read that carries an imager; all: those plus the altimetry, GNSS and ionosphere missions listed beside them. Defaults to `\"imaging\"`."
|
|
3064
|
+
},
|
|
3065
|
+
"min_elevation_deg": {
|
|
3066
|
+
"type": "number",
|
|
3067
|
+
"description": "Elevation above the horizon at the point that defines rise and set. From 0 to 90. Defaults to `10`."
|
|
3068
|
+
},
|
|
3069
|
+
"limit": {
|
|
3070
|
+
"type": "integer",
|
|
3071
|
+
"description": "Most passes to return. From 1 to 200. Defaults to `25`."
|
|
3072
|
+
}
|
|
3073
|
+
},
|
|
3074
|
+
"required": [
|
|
3075
|
+
"latitude",
|
|
3076
|
+
"longitude"
|
|
3077
|
+
]
|
|
3078
|
+
},
|
|
3079
|
+
"example": {
|
|
3080
|
+
"latitude": 34.05,
|
|
3081
|
+
"longitude": -118.25,
|
|
3082
|
+
"limit": 2
|
|
3083
|
+
}
|
|
3084
|
+
},
|
|
3085
|
+
{
|
|
3086
|
+
"name": "company_sba_loans",
|
|
3087
|
+
"path": "lookup/company-sba-loans",
|
|
3088
|
+
"title": "SBA Loans",
|
|
3089
|
+
"description": "Returns loans approved to a US business under the Small Business Administration 7(a) and 504 programs since fiscal year 2010, by borrower name, from the US Small Business Administration: lender, amount, guaranteed share, approval date, terms, industry and status. Names match substrings, so similarly named borrowers come back too. state narrows the borrower name match. No match completes with loans: []. Results are newest approval first, then largest amount; has_more indicates additional matches. Amounts are approvals, not balances. The source withholds the status of loans still being repaid (active_not_disclosed). Jobs supported are self-reported by lenders and not validated. Only 7(a) and 504 approvals since fiscal year 2010 are included, not disaster or PPP loans. Use company_federal_awards for contracts and grants. The source replaces these files quarterly; status history begins with our first observation. Street addresses are neither requested nor returned.",
|
|
3090
|
+
"inputSchema": {
|
|
3091
|
+
"type": "object",
|
|
3092
|
+
"properties": {
|
|
3093
|
+
"borrower_name": {
|
|
3094
|
+
"type": "string",
|
|
3095
|
+
"description": "Case-insensitive substring of the borrower name. 3 to 120 characters."
|
|
3096
|
+
},
|
|
3097
|
+
"state": {
|
|
3098
|
+
"type": "string",
|
|
3099
|
+
"description": "The borrower state abbreviation"
|
|
3100
|
+
},
|
|
3101
|
+
"program": {
|
|
3102
|
+
"type": "string",
|
|
3103
|
+
"enum": [
|
|
3104
|
+
"504",
|
|
3105
|
+
"7a"
|
|
3106
|
+
],
|
|
3107
|
+
"description": "Loan program; omitted searches both"
|
|
3108
|
+
},
|
|
3109
|
+
"limit": {
|
|
3110
|
+
"type": "integer",
|
|
3111
|
+
"description": "Most loans to return, newest approval first. From 1 to 25. Defaults to `10`."
|
|
3112
|
+
},
|
|
3113
|
+
"fresh": {
|
|
3114
|
+
"type": "boolean",
|
|
3115
|
+
"description": "Look the record up again instead of using OneShot's stored copy from an earlier lookup, and refresh that copy. Off by default: a record stored within its freshness window is returned as is, with cached: true and its fetched_at."
|
|
3116
|
+
}
|
|
3117
|
+
},
|
|
3118
|
+
"required": [
|
|
3119
|
+
"borrower_name"
|
|
3120
|
+
]
|
|
3121
|
+
},
|
|
3122
|
+
"example": {
|
|
3123
|
+
"borrower_name": "Faster Cajun",
|
|
3124
|
+
"state": "LA"
|
|
3125
|
+
}
|
|
3126
|
+
},
|
|
3127
|
+
{
|
|
3128
|
+
"name": "place_schools",
|
|
3129
|
+
"path": "lookup/place-schools",
|
|
3130
|
+
"title": "Schools",
|
|
3131
|
+
"description": "Lists US public schools (Common Core of Data) or private schools (Private School Survey) of the US National Center for Education Statistics within a distance of a point, nearest first, or every school of a public school district: name, address, county, grade range, kind, charter and virtual status, enrolment, teachers and student-teacher ratio. Private schools carry no enrolment. Give `school_type` and either a point (`latitude`, `longitude`, with `radius_km` 0.5 to 10, default 2) or a public `district_id` (the seven-digit NCES district id); private schools have no district. Private rows carry no enrolment, phone, district, level, kind or status: the source layer does not publish them. `total` counts the schools the source returned, at most 2,000; `more` is true when more than `limit` were returned or the source held more than 2,000. Enrolment, teachers and ratio are null when the source marks them missing, not applicable or suppressed. Each row carries its school year. A point or district with no school gives `total: 0` and an empty list.",
|
|
3132
|
+
"inputSchema": {
|
|
3133
|
+
"type": "object",
|
|
3134
|
+
"properties": {
|
|
3135
|
+
"school_type": {
|
|
3136
|
+
"type": "string",
|
|
3137
|
+
"enum": [
|
|
3138
|
+
"public",
|
|
3139
|
+
"private"
|
|
3140
|
+
],
|
|
3141
|
+
"description": "public for the Common Core of Data, private for the Private School Survey"
|
|
3142
|
+
},
|
|
3143
|
+
"latitude": {
|
|
3144
|
+
"type": "number",
|
|
3145
|
+
"description": "Latitude in decimal degrees, for example 42.2808. From -90 to 90."
|
|
3146
|
+
},
|
|
3147
|
+
"longitude": {
|
|
3148
|
+
"type": "number",
|
|
3149
|
+
"description": "Longitude in decimal degrees (west is negative), for example -83.743. From -180 to 180."
|
|
3150
|
+
},
|
|
3151
|
+
"radius_km": {
|
|
3152
|
+
"type": "number",
|
|
3153
|
+
"description": "Distance from the point in kilometres, 0.5 to 10. From 0.5 to 10. Defaults to `2`."
|
|
3154
|
+
},
|
|
3155
|
+
"district_id": {
|
|
3156
|
+
"type": "string",
|
|
3157
|
+
"description": "The seven-digit NCES district id (LEAID), for example 2602820 for Ann Arbor Public Schools; public schools only. district_id is the seven-digit NCES district id."
|
|
3158
|
+
},
|
|
3159
|
+
"limit": {
|
|
3160
|
+
"type": "integer",
|
|
3161
|
+
"description": "Most schools to return, 1 to 50. From 1 to 50. Defaults to `20`."
|
|
3162
|
+
}
|
|
3163
|
+
},
|
|
3164
|
+
"required": [
|
|
3165
|
+
"school_type"
|
|
3166
|
+
]
|
|
3167
|
+
},
|
|
3168
|
+
"example": {
|
|
3169
|
+
"school_type": "public",
|
|
3170
|
+
"latitude": 42.2808,
|
|
3171
|
+
"longitude": -83.743,
|
|
3172
|
+
"limit": 1
|
|
3173
|
+
}
|
|
3174
|
+
},
|
|
3175
|
+
{
|
|
3176
|
+
"name": "place_storm_events",
|
|
3177
|
+
"path": "lookup/place-storm-events",
|
|
3178
|
+
"title": "Storm Events",
|
|
3179
|
+
"description": "Lists the severe weather events the US National Oceanic and Atmospheric Administration recorded in a US county, parish or independent city since 1950, newest first: type, begin and end time, location, magnitude, deaths, injuries and property and crop damage. Events appear about three months after they happen; for the last three days use Hail and Wind Reports. Use it to check what hail, wind, tornado, flood or winter weather a property, a claim or a site has been through. `county` must be spelled as the source lists it (`Cleveland`, `Calcasieu Parish`, `City of Richmond`); case does not matter and a trailing ` County` may be left off. A county the source does not list returns `county_found` false and `counties`, the names it accepts for that state. `since` and `until` (YYYY-MM-DD) set the dates, both inclusive; default the last ten years. Events before 1996 cover only tornado, thunderstorm wind and hail, and before 1955 only tornadoes. `event_types` narrows to the source's types (`Hail`, `Thunderstorm Wind`, `Tornado`, `Flash Flood`, ...); omitted, every type. A county search includes events recorded on the forecast zone of the same name (`area_type` zone). Null damage means none was reported, never zero. `truncated` true means the source cut the answer at its row cap and older events in the range are missing: narrow the dates. Times carry the offset the source states; it labels times in standard time all year.",
|
|
3180
|
+
"inputSchema": {
|
|
3181
|
+
"type": "object",
|
|
3182
|
+
"properties": {
|
|
3183
|
+
"state": {
|
|
3184
|
+
"type": "string",
|
|
3185
|
+
"enum": [
|
|
3186
|
+
"AL",
|
|
3187
|
+
"AK",
|
|
3188
|
+
"AZ",
|
|
3189
|
+
"AR",
|
|
3190
|
+
"CA",
|
|
3191
|
+
"CO",
|
|
3192
|
+
"CT",
|
|
3193
|
+
"DE",
|
|
3194
|
+
"DC",
|
|
3195
|
+
"FL",
|
|
3196
|
+
"GA",
|
|
3197
|
+
"HI",
|
|
3198
|
+
"ID",
|
|
3199
|
+
"IL",
|
|
3200
|
+
"IN",
|
|
3201
|
+
"IA",
|
|
3202
|
+
"KS",
|
|
3203
|
+
"KY",
|
|
3204
|
+
"LA",
|
|
3205
|
+
"ME",
|
|
3206
|
+
"MD",
|
|
3207
|
+
"MA",
|
|
3208
|
+
"MI",
|
|
3209
|
+
"MN",
|
|
3210
|
+
"MS",
|
|
3211
|
+
"MO",
|
|
3212
|
+
"MT",
|
|
3213
|
+
"NE",
|
|
3214
|
+
"NV",
|
|
3215
|
+
"NH",
|
|
3216
|
+
"NJ",
|
|
3217
|
+
"NM",
|
|
3218
|
+
"NY",
|
|
3219
|
+
"NC",
|
|
3220
|
+
"ND",
|
|
3221
|
+
"OH",
|
|
3222
|
+
"OK",
|
|
3223
|
+
"OR",
|
|
3224
|
+
"PA",
|
|
3225
|
+
"RI",
|
|
3226
|
+
"SC",
|
|
3227
|
+
"SD",
|
|
3228
|
+
"TN",
|
|
3229
|
+
"TX",
|
|
3230
|
+
"UT",
|
|
3231
|
+
"VT",
|
|
3232
|
+
"VA",
|
|
3233
|
+
"WA",
|
|
3234
|
+
"WV",
|
|
3235
|
+
"WI",
|
|
3236
|
+
"WY",
|
|
3237
|
+
"PR",
|
|
3238
|
+
"VI",
|
|
3239
|
+
"GU",
|
|
3240
|
+
"AS"
|
|
3241
|
+
],
|
|
3242
|
+
"description": "USPS state code, for example OK; DC, PR, VI, GU and AS are accepted"
|
|
3243
|
+
},
|
|
3244
|
+
"county": {
|
|
3245
|
+
"type": "string",
|
|
3246
|
+
"description": "County, parish or independent city as the source names it, for example Cleveland, Calcasieu Parish or City of Richmond. 1 to 60 characters. Letters, digits, spaces, periods, apostrophes, parentheses and hyphens only."
|
|
3247
|
+
},
|
|
3248
|
+
"since": {
|
|
3249
|
+
"type": "string",
|
|
3250
|
+
"description": "Earliest event date; default ten years before the call. Use YYYY-MM-DD."
|
|
3251
|
+
},
|
|
3252
|
+
"until": {
|
|
3253
|
+
"type": "string",
|
|
3254
|
+
"description": "Latest event date; default the day of the call. Use YYYY-MM-DD."
|
|
3255
|
+
},
|
|
3256
|
+
"event_types": {
|
|
3257
|
+
"type": "array",
|
|
3258
|
+
"items": {
|
|
3259
|
+
"type": "string",
|
|
3260
|
+
"enum": [
|
|
3261
|
+
"Astronomical Low Tide",
|
|
3262
|
+
"Avalanche",
|
|
3263
|
+
"Blizzard",
|
|
3264
|
+
"Coastal Flood",
|
|
3265
|
+
"Cold/Wind Chill",
|
|
3266
|
+
"Debris Flow",
|
|
3267
|
+
"Dense Fog",
|
|
3268
|
+
"Dense Smoke",
|
|
3269
|
+
"Drought",
|
|
3270
|
+
"Dust Devil",
|
|
3271
|
+
"Dust Storm",
|
|
3272
|
+
"Excessive Heat",
|
|
3273
|
+
"Extreme Cold/Wind Chill",
|
|
3274
|
+
"Flash Flood",
|
|
3275
|
+
"Flood",
|
|
3276
|
+
"Freezing Fog",
|
|
3277
|
+
"Frost/Freeze",
|
|
3278
|
+
"Funnel Cloud",
|
|
3279
|
+
"Hail",
|
|
3280
|
+
"Heat",
|
|
3281
|
+
"Heavy Rain",
|
|
3282
|
+
"Heavy Snow",
|
|
3283
|
+
"High Surf",
|
|
3284
|
+
"High Wind",
|
|
3285
|
+
"Hurricane",
|
|
3286
|
+
"Ice Storm",
|
|
3287
|
+
"Lake-Effect Snow",
|
|
3288
|
+
"Lakeshore Flood",
|
|
3289
|
+
"Lightning",
|
|
3290
|
+
"Marine Dense Fog",
|
|
3291
|
+
"Marine Hail",
|
|
3292
|
+
"Marine Heavy Freezing Spray",
|
|
3293
|
+
"Marine High Wind",
|
|
3294
|
+
"Marine Hurricane/Typhoon",
|
|
3295
|
+
"Marine Lightning",
|
|
3296
|
+
"Marine Strong Wind",
|
|
3297
|
+
"Marine Thunderstorm Wind",
|
|
3298
|
+
"Marine Tropical Depression",
|
|
3299
|
+
"Marine Tropical Storm",
|
|
3300
|
+
"Rip Current",
|
|
3301
|
+
"Seiche",
|
|
3302
|
+
"Sleet",
|
|
3303
|
+
"Sneakerwave",
|
|
3304
|
+
"Storm Surge/Tide",
|
|
3305
|
+
"Strong Wind",
|
|
3306
|
+
"Thunderstorm Wind",
|
|
3307
|
+
"Tornado",
|
|
3308
|
+
"Tropical Depression",
|
|
3309
|
+
"Tropical Storm",
|
|
3310
|
+
"Tsunami",
|
|
3311
|
+
"Volcanic Ash",
|
|
3312
|
+
"Waterspout",
|
|
3313
|
+
"Wildfire",
|
|
3314
|
+
"Winter Storm",
|
|
3315
|
+
"Winter Weather"
|
|
3316
|
+
]
|
|
3317
|
+
},
|
|
3318
|
+
"description": "Event types to return, as the source names them; omitted, every type"
|
|
3319
|
+
},
|
|
3320
|
+
"limit": {
|
|
3321
|
+
"type": "integer",
|
|
3322
|
+
"description": "Most events to return. From 1 to 200. Defaults to `50`."
|
|
3323
|
+
}
|
|
3324
|
+
},
|
|
3325
|
+
"required": [
|
|
3326
|
+
"state",
|
|
3327
|
+
"county"
|
|
3328
|
+
]
|
|
3329
|
+
},
|
|
3330
|
+
"example": {
|
|
3331
|
+
"state": "OK",
|
|
3332
|
+
"county": "Cleveland",
|
|
3333
|
+
"since": "2013-05-20",
|
|
3334
|
+
"until": "2013-05-20",
|
|
3335
|
+
"event_types": [
|
|
3336
|
+
"Tornado"
|
|
3337
|
+
]
|
|
3338
|
+
}
|
|
3339
|
+
},
|
|
3340
|
+
{
|
|
3341
|
+
"name": "place_tropical_cyclones",
|
|
3342
|
+
"path": "lookup/place-tropical-cyclones",
|
|
3343
|
+
"title": "Tropical Cyclones",
|
|
3344
|
+
"description": "Lists active storms and official forecast points in the Atlantic and eastern/central North Pacific. Source fields are observed; movement_kt, distance_km, closest_approach_km and closest_approach_at are derived. Empty storms with coverage.covered true means looked, saw nothing matching; false means no evidence either way. Coverage names watched basins and latest advisory time. West Pacific and Indian Ocean are unwatched. All inputs are optional. With no point, lists all active storms; basin can narrow the list. Limit defaults to 25, at most 200. Derived movement_kt converts observed movement_mph to knots; distance_km is a great-circle distance. Each derived value names its rule and input fields. Point coverage uses the northern hemisphere from the date line east to 20E, including coastal and inland sites. Coverage does not extend to the other hemisphere or other basins when a radius crosses the boundary. Closest approach uses shortest great-circle segments with time interpolated between official points, starting at the current position. It is a forecast, not a measured impact or wind footprint. The uncertainty cone is omitted. The latest advisory and forecast must match. Missing or incomplete forecast data fails the lookup instead of implying there are no nearby storms. NWS public-data terms apply: https://www.weather.gov/disclaimer. No endorsement is implied.",
|
|
3345
|
+
"inputSchema": {
|
|
3346
|
+
"type": "object",
|
|
3347
|
+
"properties": {
|
|
3348
|
+
"latitude": {
|
|
3349
|
+
"type": "number",
|
|
3350
|
+
"description": "Latitude in decimal degrees; give longitude too. From -90 to 90."
|
|
3351
|
+
},
|
|
3352
|
+
"longitude": {
|
|
3353
|
+
"type": "number",
|
|
3354
|
+
"description": "Longitude in decimal degrees; west is negative. From -180 to 180."
|
|
3355
|
+
},
|
|
3356
|
+
"radius_km": {
|
|
3357
|
+
"type": "number",
|
|
3358
|
+
"description": "Maximum current or forecast distance from the point in kilometres. From 1 to 2000. Defaults to `500`."
|
|
3359
|
+
},
|
|
3360
|
+
"basin": {
|
|
3361
|
+
"type": "string",
|
|
3362
|
+
"enum": [
|
|
3363
|
+
"atlantic",
|
|
3364
|
+
"east_pacific",
|
|
3365
|
+
"central_pacific"
|
|
3366
|
+
],
|
|
3367
|
+
"description": "Basin to list; omitted means all three watched basins"
|
|
3368
|
+
},
|
|
3369
|
+
"limit": {
|
|
3370
|
+
"type": "integer",
|
|
3371
|
+
"description": "Maximum storms to return. From 1 to 200. Defaults to `25`."
|
|
3372
|
+
}
|
|
3373
|
+
},
|
|
3374
|
+
"required": []
|
|
3375
|
+
},
|
|
3376
|
+
"example": {
|
|
3377
|
+
"limit": 10
|
|
3378
|
+
}
|
|
3379
|
+
},
|
|
2064
3380
|
{
|
|
2065
3381
|
"name": "market_truck_rates",
|
|
2066
3382
|
"path": "lookup/market-truck-rates",
|
|
@@ -2698,13 +4014,61 @@ export const ROUTE_MANIFEST = [
|
|
|
2698
4014
|
}
|
|
2699
4015
|
},
|
|
2700
4016
|
{
|
|
2701
|
-
"name": "
|
|
2702
|
-
"method": "
|
|
2703
|
-
"path": "/v1/
|
|
2704
|
-
"paid":
|
|
4017
|
+
"name": "company_dossier",
|
|
4018
|
+
"method": "POST",
|
|
4019
|
+
"path": "/v1/tools/lookup/company-dossier",
|
|
4020
|
+
"paid": true,
|
|
2705
4021
|
"readOnly": true,
|
|
2706
|
-
"title": "
|
|
2707
|
-
"description": "
|
|
4022
|
+
"title": "Company Dossier",
|
|
4023
|
+
"description": "One call that answers \"who is this company?\": its identifiers, identity, locations, operations and size, licences and registrations, court cases, regulatory results, key people, recent news and a written summary, each section with its state and sources and each entry tied to the company by an identifier. Key people (name, title, work email) are included unless include_people is false. Give the name and at least one of domain, address or state; add the USDOT number for a motor carrier. Runs for up to 15 minutes and answers with a request id to poll. Paid per call at one fixed price.",
|
|
4024
|
+
"inputSchema": {
|
|
4025
|
+
"type": "object",
|
|
4026
|
+
"properties": {
|
|
4027
|
+
"name": {
|
|
4028
|
+
"type": "string",
|
|
4029
|
+
"description": "The company name"
|
|
4030
|
+
},
|
|
4031
|
+
"domain": {
|
|
4032
|
+
"type": "string",
|
|
4033
|
+
"description": "The company website domain. Give at least one of domain, address or state"
|
|
4034
|
+
},
|
|
4035
|
+
"address": {
|
|
4036
|
+
"type": "string",
|
|
4037
|
+
"description": "A street address of the company. Give at least one of domain, address or state"
|
|
4038
|
+
},
|
|
4039
|
+
"state": {
|
|
4040
|
+
"type": "string",
|
|
4041
|
+
"description": "Two-letter US state the company is in or formed in. Give at least one of domain, address or state"
|
|
4042
|
+
},
|
|
4043
|
+
"dot_number": {
|
|
4044
|
+
"type": "string",
|
|
4045
|
+
"description": "USDOT number, digits only, for a motor carrier"
|
|
4046
|
+
},
|
|
4047
|
+
"include_people": {
|
|
4048
|
+
"type": "boolean",
|
|
4049
|
+
"default": true,
|
|
4050
|
+
"description": "Key people (name, title, work email) are included unless this is false"
|
|
4051
|
+
}
|
|
4052
|
+
},
|
|
4053
|
+
"required": [
|
|
4054
|
+
"name"
|
|
4055
|
+
]
|
|
4056
|
+
},
|
|
4057
|
+
"example": {
|
|
4058
|
+
"name": "Example Freight LLC",
|
|
4059
|
+
"state": "TX",
|
|
4060
|
+
"dot_number": "1234567"
|
|
4061
|
+
},
|
|
4062
|
+
"timeout": 1020
|
|
4063
|
+
},
|
|
4064
|
+
{
|
|
4065
|
+
"name": "compute_budget",
|
|
4066
|
+
"method": "GET",
|
|
4067
|
+
"path": "/v1/compute/{goal_id}/budget",
|
|
4068
|
+
"paid": false,
|
|
4069
|
+
"readOnly": true,
|
|
4070
|
+
"title": "Compute Budget",
|
|
4071
|
+
"description": "Read what a compute goal has reserved, spent and has left. Free.",
|
|
2708
4072
|
"inputSchema": {
|
|
2709
4073
|
"type": "object",
|
|
2710
4074
|
"properties": {
|
|
@@ -2757,7 +4121,7 @@ export const ROUTE_MANIFEST = [
|
|
|
2757
4121
|
"paid": true,
|
|
2758
4122
|
"readOnly": true,
|
|
2759
4123
|
"title": "CRM accounts",
|
|
2760
|
-
"description": "Read accounts from a connected Salesforce or
|
|
4124
|
+
"description": "Read accounts from a connected Salesforce, HubSpot or Affinity account. Read-only. Nothing fetched is stored. Paid per read. Call oneshot_connections_list first and pick the connection_id by system and account_label.",
|
|
2761
4125
|
"inputSchema": {
|
|
2762
4126
|
"type": "object",
|
|
2763
4127
|
"properties": {
|
|
@@ -2791,6 +4155,70 @@ export const ROUTE_MANIFEST = [
|
|
|
2791
4155
|
"limit": 25
|
|
2792
4156
|
}
|
|
2793
4157
|
},
|
|
4158
|
+
{
|
|
4159
|
+
"name": "crm_activity",
|
|
4160
|
+
"method": "POST",
|
|
4161
|
+
"path": "/v1/tools/crm/activity",
|
|
4162
|
+
"paid": true,
|
|
4163
|
+
"readOnly": true,
|
|
4164
|
+
"title": "CRM activity",
|
|
4165
|
+
"description": "Read what already happened on a connected HubSpot account, contact, opportunity or ticket: emails, calls, meetings, notes and tasks, each with a short summary of its body. Read-only. Nothing fetched is stored; bodies are customer content. Salesforce does not serve this read yet. Paid per read. Call oneshot_connections_list first and pick the connection_id by system and account_label.",
|
|
4166
|
+
"inputSchema": {
|
|
4167
|
+
"type": "object",
|
|
4168
|
+
"properties": {
|
|
4169
|
+
"connection_id": {
|
|
4170
|
+
"type": "string",
|
|
4171
|
+
"description": "The connection to read. An agent can have several connections to the same system: list your connections first (`GET /v1/connections`) and pick by `system` and `account_label`."
|
|
4172
|
+
},
|
|
4173
|
+
"record": {
|
|
4174
|
+
"type": "object",
|
|
4175
|
+
"properties": {
|
|
4176
|
+
"type": {
|
|
4177
|
+
"type": "string",
|
|
4178
|
+
"enum": [
|
|
4179
|
+
"account",
|
|
4180
|
+
"contact",
|
|
4181
|
+
"opportunity",
|
|
4182
|
+
"ticket"
|
|
4183
|
+
]
|
|
4184
|
+
},
|
|
4185
|
+
"id": {
|
|
4186
|
+
"type": "string"
|
|
4187
|
+
}
|
|
4188
|
+
},
|
|
4189
|
+
"required": [
|
|
4190
|
+
"type",
|
|
4191
|
+
"id"
|
|
4192
|
+
],
|
|
4193
|
+
"additionalProperties": false
|
|
4194
|
+
},
|
|
4195
|
+
"since": {
|
|
4196
|
+
"type": "string",
|
|
4197
|
+
"description": "Activity on or after this ISO date (YYYY-MM-DD, UTC)"
|
|
4198
|
+
},
|
|
4199
|
+
"limit": {
|
|
4200
|
+
"type": "number",
|
|
4201
|
+
"description": "Records per page (1 to 100, default 25)"
|
|
4202
|
+
},
|
|
4203
|
+
"cursor": {
|
|
4204
|
+
"type": "string",
|
|
4205
|
+
"description": "The next_cursor of the previous page; keep the same filters"
|
|
4206
|
+
}
|
|
4207
|
+
},
|
|
4208
|
+
"required": [
|
|
4209
|
+
"connection_id",
|
|
4210
|
+
"record"
|
|
4211
|
+
]
|
|
4212
|
+
},
|
|
4213
|
+
"example": {
|
|
4214
|
+
"connection_id": "5f4a3b2c-1d0e-4f9a-8b7c-6d5e4f3a2b1c",
|
|
4215
|
+
"record": {
|
|
4216
|
+
"type": "contact",
|
|
4217
|
+
"id": "101"
|
|
4218
|
+
},
|
|
4219
|
+
"limit": 25
|
|
4220
|
+
}
|
|
4221
|
+
},
|
|
2794
4222
|
{
|
|
2795
4223
|
"name": "crm_contacts",
|
|
2796
4224
|
"method": "POST",
|
|
@@ -2798,7 +4226,7 @@ export const ROUTE_MANIFEST = [
|
|
|
2798
4226
|
"paid": true,
|
|
2799
4227
|
"readOnly": true,
|
|
2800
4228
|
"title": "CRM contacts",
|
|
2801
|
-
"description": "Read contacts from a connected Salesforce or
|
|
4229
|
+
"description": "Read contacts from a connected Salesforce, HubSpot, Follow Up Boss or Affinity account. Read-only. Nothing fetched is stored. Contacts include personal data, returned inline only. Paid per read. Call oneshot_connections_list first and pick the connection_id by system and account_label.",
|
|
2802
4230
|
"inputSchema": {
|
|
2803
4231
|
"type": "object",
|
|
2804
4232
|
"properties": {
|
|
@@ -2843,7 +4271,7 @@ export const ROUTE_MANIFEST = [
|
|
|
2843
4271
|
"paid": true,
|
|
2844
4272
|
"readOnly": true,
|
|
2845
4273
|
"title": "CRM opportunities",
|
|
2846
|
-
"description": "Read opportunities from a connected Salesforce or
|
|
4274
|
+
"description": "Read opportunities from a connected Salesforce, HubSpot, Follow Up Boss or Affinity account. Read-only. Nothing fetched is stored. Paid per read. Call oneshot_connections_list first and pick the connection_id by system and account_label.",
|
|
2847
4275
|
"inputSchema": {
|
|
2848
4276
|
"type": "object",
|
|
2849
4277
|
"properties": {
|
|
@@ -2891,6 +4319,64 @@ export const ROUTE_MANIFEST = [
|
|
|
2891
4319
|
"limit": 25
|
|
2892
4320
|
}
|
|
2893
4321
|
},
|
|
4322
|
+
{
|
|
4323
|
+
"name": "crm_tickets",
|
|
4324
|
+
"method": "POST",
|
|
4325
|
+
"path": "/v1/tools/crm/tickets",
|
|
4326
|
+
"paid": true,
|
|
4327
|
+
"readOnly": true,
|
|
4328
|
+
"title": "CRM tickets",
|
|
4329
|
+
"description": "Read support tickets from a connected HubSpot account, with their contact and company. Read-only. Nothing fetched is stored. Other CRM systems do not serve this read. Paid per read. Call oneshot_connections_list first and pick the connection_id by system and account_label.",
|
|
4330
|
+
"inputSchema": {
|
|
4331
|
+
"type": "object",
|
|
4332
|
+
"properties": {
|
|
4333
|
+
"connection_id": {
|
|
4334
|
+
"type": "string",
|
|
4335
|
+
"description": "The connection to read. An agent can have several connections to the same system: list your connections first (`GET /v1/connections`) and pick by `system` and `account_label`."
|
|
4336
|
+
},
|
|
4337
|
+
"query": {
|
|
4338
|
+
"type": "string",
|
|
4339
|
+
"description": "Subject contains this text, case insensitive. A filtered page can be empty; continue while next_cursor is present."
|
|
4340
|
+
},
|
|
4341
|
+
"updated_since": {
|
|
4342
|
+
"type": "string",
|
|
4343
|
+
"description": "Updated on or after this ISO date (YYYY-MM-DD, UTC)"
|
|
4344
|
+
},
|
|
4345
|
+
"limit": {
|
|
4346
|
+
"type": "number",
|
|
4347
|
+
"description": "Records per page (1 to 100, default 25)"
|
|
4348
|
+
},
|
|
4349
|
+
"cursor": {
|
|
4350
|
+
"type": "string",
|
|
4351
|
+
"description": "The next_cursor of the previous page; keep the same filters"
|
|
4352
|
+
},
|
|
4353
|
+
"status": {
|
|
4354
|
+
"type": "string",
|
|
4355
|
+
"enum": [
|
|
4356
|
+
"open",
|
|
4357
|
+
"closed",
|
|
4358
|
+
"all"
|
|
4359
|
+
],
|
|
4360
|
+
"description": "Ticket status (default all)"
|
|
4361
|
+
},
|
|
4362
|
+
"contact_id": {
|
|
4363
|
+
"type": "string",
|
|
4364
|
+
"description": "Only tickets associated with this contact id"
|
|
4365
|
+
},
|
|
4366
|
+
"company_id": {
|
|
4367
|
+
"type": "string",
|
|
4368
|
+
"description": "Only tickets associated with this company (account) id"
|
|
4369
|
+
}
|
|
4370
|
+
},
|
|
4371
|
+
"required": [
|
|
4372
|
+
"connection_id"
|
|
4373
|
+
]
|
|
4374
|
+
},
|
|
4375
|
+
"example": {
|
|
4376
|
+
"connection_id": "5f4a3b2c-1d0e-4f9a-8b7c-6d5e4f3a2b1c",
|
|
4377
|
+
"limit": 25
|
|
4378
|
+
}
|
|
4379
|
+
},
|
|
2894
4380
|
{
|
|
2895
4381
|
"name": "watch_delete",
|
|
2896
4382
|
"method": "DELETE",
|
|
@@ -2939,6 +4425,386 @@ export const ROUTE_MANIFEST = [
|
|
|
2939
4425
|
"domain": "mail.example.com"
|
|
2940
4426
|
}
|
|
2941
4427
|
},
|
|
4428
|
+
{
|
|
4429
|
+
"name": "company_export_restrictions",
|
|
4430
|
+
"method": "POST",
|
|
4431
|
+
"path": "/v1/tools/lookup/company-export-restrictions",
|
|
4432
|
+
"paid": true,
|
|
4433
|
+
"readOnly": true,
|
|
4434
|
+
"title": "Export Restrictions",
|
|
4435
|
+
"description": "Search US export-control lists by counterparty name and aliases, optionally narrowed by address country. Returns scored matches, the matched name, list, licence requirement and policy, and the published entry fields. For example, “Is Huawei Technologies on an export-control list?” or “Check export restrictions and licence requirements; company_sanctions checks the Treasury SDN list.” No match means no entry on these lists scored at or above min_score; it does not clear the party. Commerce Entity, Denied Persons, Unverified and Military End User lists; State Department ITAR debarred and nonproliferation sanctions, as published in the Consolidated Screening List. The source refreshes daily at 5:00 AM Eastern. Entries include organisations and individuals. Treasury lists are excluded. This is a screening aid; the official Federal Register publication governs.",
|
|
4436
|
+
"inputSchema": {
|
|
4437
|
+
"type": "object",
|
|
4438
|
+
"properties": {
|
|
4439
|
+
"name": {
|
|
4440
|
+
"type": "string",
|
|
4441
|
+
"minLength": 2,
|
|
4442
|
+
"maxLength": 200,
|
|
4443
|
+
"description": "Counterparty name, 2 to 200 characters"
|
|
4444
|
+
},
|
|
4445
|
+
"country": {
|
|
4446
|
+
"type": "string",
|
|
4447
|
+
"pattern": "^[A-Za-z]{2}$",
|
|
4448
|
+
"description": "Optional two-letter country code; narrows matches by address country"
|
|
4449
|
+
},
|
|
4450
|
+
"min_score": {
|
|
4451
|
+
"type": "number",
|
|
4452
|
+
"minimum": 0.5,
|
|
4453
|
+
"maximum": 1,
|
|
4454
|
+
"default": 0.85,
|
|
4455
|
+
"description": "Minimum name score, 0.5 to 1; default 0.85"
|
|
4456
|
+
},
|
|
4457
|
+
"limit": {
|
|
4458
|
+
"type": "integer",
|
|
4459
|
+
"minimum": 1,
|
|
4460
|
+
"maximum": 25,
|
|
4461
|
+
"default": 10,
|
|
4462
|
+
"description": "Most matches returned, 1 to 25; default 10. Total counts all qualifying entries"
|
|
4463
|
+
}
|
|
4464
|
+
},
|
|
4465
|
+
"required": [
|
|
4466
|
+
"name"
|
|
4467
|
+
]
|
|
4468
|
+
},
|
|
4469
|
+
"example": {
|
|
4470
|
+
"name": "Huawei Technologies Co., Ltd."
|
|
4471
|
+
}
|
|
4472
|
+
},
|
|
4473
|
+
{
|
|
4474
|
+
"name": "field_service_clients",
|
|
4475
|
+
"method": "POST",
|
|
4476
|
+
"path": "/v1/tools/field_service/clients",
|
|
4477
|
+
"paid": true,
|
|
4478
|
+
"readOnly": true,
|
|
4479
|
+
"title": "Field service clients",
|
|
4480
|
+
"description": "Clients read from the customer's connected field service system, with contact details, tags and balance, filtered by text and by last change. Read-only. Paid per read. Call oneshot_connections_list first and pick the connection_id by system and account_label.",
|
|
4481
|
+
"inputSchema": {
|
|
4482
|
+
"type": "object",
|
|
4483
|
+
"properties": {
|
|
4484
|
+
"connection_id": {
|
|
4485
|
+
"type": "string",
|
|
4486
|
+
"description": "The connection to read. An agent can have several connections to the same system: list your connections first (`GET /v1/connections`) and pick by `system` and `account_label`."
|
|
4487
|
+
},
|
|
4488
|
+
"query": {
|
|
4489
|
+
"type": "string",
|
|
4490
|
+
"description": "Clients whose name, company, email, phone or property matches this text"
|
|
4491
|
+
},
|
|
4492
|
+
"updated_since": {
|
|
4493
|
+
"type": "string",
|
|
4494
|
+
"description": "Clients changed on or after this day (YYYY-MM-DD, UTC)"
|
|
4495
|
+
},
|
|
4496
|
+
"limit": {
|
|
4497
|
+
"type": "integer",
|
|
4498
|
+
"description": "Clients per page, 1 to 100 (default 25)"
|
|
4499
|
+
},
|
|
4500
|
+
"cursor": {
|
|
4501
|
+
"type": "string",
|
|
4502
|
+
"description": "The next_cursor of the previous page"
|
|
4503
|
+
}
|
|
4504
|
+
},
|
|
4505
|
+
"required": [
|
|
4506
|
+
"connection_id"
|
|
4507
|
+
]
|
|
4508
|
+
},
|
|
4509
|
+
"example": {
|
|
4510
|
+
"connection_id": "6f1c2d3e-4b5a-4c6d-8e7f-9a0b1c2d3e4f",
|
|
4511
|
+
"query": "Reyes",
|
|
4512
|
+
"limit": 25
|
|
4513
|
+
}
|
|
4514
|
+
},
|
|
4515
|
+
{
|
|
4516
|
+
"name": "field_service_invoices",
|
|
4517
|
+
"method": "POST",
|
|
4518
|
+
"path": "/v1/tools/field_service/invoices",
|
|
4519
|
+
"paid": true,
|
|
4520
|
+
"readOnly": true,
|
|
4521
|
+
"title": "Field service invoices",
|
|
4522
|
+
"description": "Invoices read from the customer's connected field service system, each with its client, status, total, balance and dates, filtered by client, status and due date. Read-only: nothing is sent or collected. Paid per read. Call oneshot_connections_list first and pick the connection_id by system and account_label.",
|
|
4523
|
+
"inputSchema": {
|
|
4524
|
+
"type": "object",
|
|
4525
|
+
"properties": {
|
|
4526
|
+
"connection_id": {
|
|
4527
|
+
"type": "string",
|
|
4528
|
+
"description": "The connection to read. An agent can have several connections to the same system: list your connections first (`GET /v1/connections`) and pick by `system` and `account_label`."
|
|
4529
|
+
},
|
|
4530
|
+
"client_id": {
|
|
4531
|
+
"type": "string",
|
|
4532
|
+
"description": "Only this client's records, by the id field_service_clients answers"
|
|
4533
|
+
},
|
|
4534
|
+
"status": {
|
|
4535
|
+
"type": "string",
|
|
4536
|
+
"enum": [
|
|
4537
|
+
"draft",
|
|
4538
|
+
"awaiting_payment",
|
|
4539
|
+
"past_due",
|
|
4540
|
+
"paid",
|
|
4541
|
+
"all"
|
|
4542
|
+
],
|
|
4543
|
+
"description": "draft, awaiting_payment, past_due, paid or all (default all)"
|
|
4544
|
+
},
|
|
4545
|
+
"due_before": {
|
|
4546
|
+
"type": "string",
|
|
4547
|
+
"description": "Invoices due on or before this day (YYYY-MM-DD, UTC)"
|
|
4548
|
+
},
|
|
4549
|
+
"limit": {
|
|
4550
|
+
"type": "integer",
|
|
4551
|
+
"description": "Invoices per page, 1 to 100 (default 25)"
|
|
4552
|
+
},
|
|
4553
|
+
"cursor": {
|
|
4554
|
+
"type": "string",
|
|
4555
|
+
"description": "The next_cursor of the previous page"
|
|
4556
|
+
}
|
|
4557
|
+
},
|
|
4558
|
+
"required": [
|
|
4559
|
+
"connection_id"
|
|
4560
|
+
]
|
|
4561
|
+
},
|
|
4562
|
+
"example": {
|
|
4563
|
+
"connection_id": "6f1c2d3e-4b5a-4c6d-8e7f-9a0b1c2d3e4f",
|
|
4564
|
+
"status": "past_due",
|
|
4565
|
+
"due_before": "2026-10-20",
|
|
4566
|
+
"limit": 25
|
|
4567
|
+
}
|
|
4568
|
+
},
|
|
4569
|
+
{
|
|
4570
|
+
"name": "field_service_jobs",
|
|
4571
|
+
"method": "POST",
|
|
4572
|
+
"path": "/v1/tools/field_service/jobs",
|
|
4573
|
+
"paid": true,
|
|
4574
|
+
"readOnly": true,
|
|
4575
|
+
"title": "Field service jobs",
|
|
4576
|
+
"description": "Jobs read from the customer's connected field service system, each with its client, status, total and visits, filtered by client, status and visit dates. Read-only: nothing is scheduled or changed. Paid per read. Call oneshot_connections_list first and pick the connection_id by system and account_label.",
|
|
4577
|
+
"inputSchema": {
|
|
4578
|
+
"type": "object",
|
|
4579
|
+
"properties": {
|
|
4580
|
+
"connection_id": {
|
|
4581
|
+
"type": "string",
|
|
4582
|
+
"description": "The connection to read. An agent can have several connections to the same system: list your connections first (`GET /v1/connections`) and pick by `system` and `account_label`."
|
|
4583
|
+
},
|
|
4584
|
+
"client_id": {
|
|
4585
|
+
"type": "string",
|
|
4586
|
+
"description": "Only this client's records, by the id field_service_clients answers"
|
|
4587
|
+
},
|
|
4588
|
+
"status": {
|
|
4589
|
+
"type": "string",
|
|
4590
|
+
"enum": [
|
|
4591
|
+
"upcoming",
|
|
4592
|
+
"active",
|
|
4593
|
+
"late",
|
|
4594
|
+
"completed",
|
|
4595
|
+
"all"
|
|
4596
|
+
],
|
|
4597
|
+
"description": "upcoming, active, late, completed or all (default all)"
|
|
4598
|
+
},
|
|
4599
|
+
"scheduled_after": {
|
|
4600
|
+
"type": "string",
|
|
4601
|
+
"description": "Jobs with a visit on or after this day (YYYY-MM-DD, UTC)"
|
|
4602
|
+
},
|
|
4603
|
+
"scheduled_before": {
|
|
4604
|
+
"type": "string",
|
|
4605
|
+
"description": "Jobs with a visit on or before this day (YYYY-MM-DD, UTC)"
|
|
4606
|
+
},
|
|
4607
|
+
"limit": {
|
|
4608
|
+
"type": "integer",
|
|
4609
|
+
"description": "Jobs per page, 1 to 100 (default 25)"
|
|
4610
|
+
},
|
|
4611
|
+
"cursor": {
|
|
4612
|
+
"type": "string",
|
|
4613
|
+
"description": "The next_cursor of the previous page"
|
|
4614
|
+
}
|
|
4615
|
+
},
|
|
4616
|
+
"required": [
|
|
4617
|
+
"connection_id"
|
|
4618
|
+
]
|
|
4619
|
+
},
|
|
4620
|
+
"example": {
|
|
4621
|
+
"connection_id": "6f1c2d3e-4b5a-4c6d-8e7f-9a0b1c2d3e4f",
|
|
4622
|
+
"status": "upcoming",
|
|
4623
|
+
"scheduled_after": "2026-10-21",
|
|
4624
|
+
"scheduled_before": "2026-10-21",
|
|
4625
|
+
"limit": 25
|
|
4626
|
+
}
|
|
4627
|
+
},
|
|
4628
|
+
{
|
|
4629
|
+
"name": "field_service_quotes",
|
|
4630
|
+
"method": "POST",
|
|
4631
|
+
"path": "/v1/tools/field_service/quotes",
|
|
4632
|
+
"paid": true,
|
|
4633
|
+
"readOnly": true,
|
|
4634
|
+
"title": "Field service quotes",
|
|
4635
|
+
"description": "Quotes read from the customer's connected field service system, each with its client, status, total and when it was sent and approved, filtered by client, status and send date. Read-only: nothing is sent or approved. Paid per read. Call oneshot_connections_list first and pick the connection_id by system and account_label.",
|
|
4636
|
+
"inputSchema": {
|
|
4637
|
+
"type": "object",
|
|
4638
|
+
"properties": {
|
|
4639
|
+
"connection_id": {
|
|
4640
|
+
"type": "string",
|
|
4641
|
+
"description": "The connection to read. An agent can have several connections to the same system: list your connections first (`GET /v1/connections`) and pick by `system` and `account_label`."
|
|
4642
|
+
},
|
|
4643
|
+
"client_id": {
|
|
4644
|
+
"type": "string",
|
|
4645
|
+
"description": "Only this client's records, by the id field_service_clients answers"
|
|
4646
|
+
},
|
|
4647
|
+
"status": {
|
|
4648
|
+
"type": "string",
|
|
4649
|
+
"enum": [
|
|
4650
|
+
"draft",
|
|
4651
|
+
"awaiting_response",
|
|
4652
|
+
"approved",
|
|
4653
|
+
"converted",
|
|
4654
|
+
"archived",
|
|
4655
|
+
"all"
|
|
4656
|
+
],
|
|
4657
|
+
"description": "draft, awaiting_response, approved, converted, archived or all (default all)"
|
|
4658
|
+
},
|
|
4659
|
+
"sent_after": {
|
|
4660
|
+
"type": "string",
|
|
4661
|
+
"description": "Quotes last sent to the client on or after this day (YYYY-MM-DD, UTC)"
|
|
4662
|
+
},
|
|
4663
|
+
"limit": {
|
|
4664
|
+
"type": "integer",
|
|
4665
|
+
"description": "Quotes per page, 1 to 100 (default 25)"
|
|
4666
|
+
},
|
|
4667
|
+
"cursor": {
|
|
4668
|
+
"type": "string",
|
|
4669
|
+
"description": "The next_cursor of the previous page"
|
|
4670
|
+
}
|
|
4671
|
+
},
|
|
4672
|
+
"required": [
|
|
4673
|
+
"connection_id"
|
|
4674
|
+
]
|
|
4675
|
+
},
|
|
4676
|
+
"example": {
|
|
4677
|
+
"connection_id": "6f1c2d3e-4b5a-4c6d-8e7f-9a0b1c2d3e4f",
|
|
4678
|
+
"status": "awaiting_response",
|
|
4679
|
+
"sent_after": "2026-10-01",
|
|
4680
|
+
"limit": 25
|
|
4681
|
+
}
|
|
4682
|
+
},
|
|
4683
|
+
{
|
|
4684
|
+
"name": "files_read",
|
|
4685
|
+
"method": "POST",
|
|
4686
|
+
"path": "/v1/tools/files/read",
|
|
4687
|
+
"paid": true,
|
|
4688
|
+
"readOnly": true,
|
|
4689
|
+
"title": "File read",
|
|
4690
|
+
"description": "Read content inline, at most 10 MB. Google Drive supports Sheets as CSV (first or named sheet); other Drive content is not supported yet. Known oversized content is refused before payment. Nothing fetched is stored. Paid per read. Call oneshot_connections_list first and pick the connection_id by system and account_label.",
|
|
4691
|
+
"inputSchema": {
|
|
4692
|
+
"type": "object",
|
|
4693
|
+
"properties": {
|
|
4694
|
+
"connection_id": {
|
|
4695
|
+
"type": "string",
|
|
4696
|
+
"format": "uuid",
|
|
4697
|
+
"description": "List GET /v1/connections first and choose by system and account_label."
|
|
4698
|
+
},
|
|
4699
|
+
"file_id": {
|
|
4700
|
+
"type": "string",
|
|
4701
|
+
"description": "Opaque id returned by files/search; pass it unchanged."
|
|
4702
|
+
},
|
|
4703
|
+
"sheet": {
|
|
4704
|
+
"type": "string",
|
|
4705
|
+
"minLength": 1,
|
|
4706
|
+
"maxLength": 100,
|
|
4707
|
+
"description": "Google Sheets tab name; omitted means the first sheet. Other file types do not support this option."
|
|
4708
|
+
}
|
|
4709
|
+
},
|
|
4710
|
+
"required": [
|
|
4711
|
+
"connection_id",
|
|
4712
|
+
"file_id"
|
|
4713
|
+
]
|
|
4714
|
+
},
|
|
4715
|
+
"example": {
|
|
4716
|
+
"connection_id": "00000000-0000-4000-8000-000000000001",
|
|
4717
|
+
"file_id": "drive-1:file-1"
|
|
4718
|
+
}
|
|
4719
|
+
},
|
|
4720
|
+
{
|
|
4721
|
+
"name": "files_search",
|
|
4722
|
+
"method": "POST",
|
|
4723
|
+
"path": "/v1/tools/files/search",
|
|
4724
|
+
"paid": true,
|
|
4725
|
+
"readOnly": true,
|
|
4726
|
+
"title": "File search",
|
|
4727
|
+
"description": "Search file metadata on the chosen connection. At most 50 rows. Nothing fetched is stored. Paid per read. Call oneshot_connections_list first and pick the connection_id by system and account_label.",
|
|
4728
|
+
"inputSchema": {
|
|
4729
|
+
"type": "object",
|
|
4730
|
+
"properties": {
|
|
4731
|
+
"connection_id": {
|
|
4732
|
+
"type": "string",
|
|
4733
|
+
"format": "uuid",
|
|
4734
|
+
"description": "List GET /v1/connections first and choose by system and account_label."
|
|
4735
|
+
},
|
|
4736
|
+
"query": {
|
|
4737
|
+
"type": "string",
|
|
4738
|
+
"minLength": 1,
|
|
4739
|
+
"maxLength": 500,
|
|
4740
|
+
"description": "Required search text. Keep the same filters when paging."
|
|
4741
|
+
},
|
|
4742
|
+
"limit": {
|
|
4743
|
+
"type": "integer",
|
|
4744
|
+
"minimum": 1,
|
|
4745
|
+
"maximum": 50,
|
|
4746
|
+
"default": 25
|
|
4747
|
+
},
|
|
4748
|
+
"cursor": {
|
|
4749
|
+
"type": "string",
|
|
4750
|
+
"description": "The next_cursor from the previous page."
|
|
4751
|
+
},
|
|
4752
|
+
"folder_id": {
|
|
4753
|
+
"type": "string",
|
|
4754
|
+
"description": "Optional opaque folder id. Recursive for Box and Microsoft; direct children for Google Drive."
|
|
4755
|
+
}
|
|
4756
|
+
},
|
|
4757
|
+
"required": [
|
|
4758
|
+
"connection_id",
|
|
4759
|
+
"query"
|
|
4760
|
+
]
|
|
4761
|
+
},
|
|
4762
|
+
"example": {
|
|
4763
|
+
"connection_id": "00000000-0000-4000-8000-000000000001",
|
|
4764
|
+
"query": "invoice",
|
|
4765
|
+
"limit": 25
|
|
4766
|
+
}
|
|
4767
|
+
},
|
|
4768
|
+
{
|
|
4769
|
+
"name": "company_fund_holdings",
|
|
4770
|
+
"method": "POST",
|
|
4771
|
+
"path": "/v1/tools/lookup/company-fund-holdings",
|
|
4772
|
+
"paid": true,
|
|
4773
|
+
"readOnly": true,
|
|
4774
|
+
"title": "Fund Holdings",
|
|
4775
|
+
"description": "Look up an institutional investment manager’s quarterly Form 13F holdings by manager CIK: issuer, class, CUSIP, FIGI, value in dollars, shares or principal, put or call, investment discretion and voting authority, largest first. For example, “What did Berkshire Hathaway hold at the end of June 2026?” or “Show the positions inside a 13F-HR, beyond the filing that company_filings with form 13F-HR lists.” Form 13F-HR and 13F-HR/A information tables of institutional investment managers. Holdings are reported quarterly, up to 45 days after each quarter ends, and loaded from data sets the SEC posts every three months, so the newest period can be several months old. The four newest data sets (a year of filing dates) are held. Values are in US dollars as reported; confidential holdings the SEC allowed a manager to omit are not listed.",
|
|
4776
|
+
"inputSchema": {
|
|
4777
|
+
"type": "object",
|
|
4778
|
+
"properties": {
|
|
4779
|
+
"cik": {
|
|
4780
|
+
"type": "string",
|
|
4781
|
+
"description": "Investment manager CIK, 1 to 10 digits"
|
|
4782
|
+
},
|
|
4783
|
+
"period": {
|
|
4784
|
+
"type": "string",
|
|
4785
|
+
"description": "Quarter end the report covers, YYYY-MM-DD; default the newest loaded period"
|
|
4786
|
+
},
|
|
4787
|
+
"cusip": {
|
|
4788
|
+
"type": "string",
|
|
4789
|
+
"description": "Nine-character CUSIP; only holdings of this security"
|
|
4790
|
+
},
|
|
4791
|
+
"limit": {
|
|
4792
|
+
"type": "integer",
|
|
4793
|
+
"description": "Page size, 1-500, default 100"
|
|
4794
|
+
},
|
|
4795
|
+
"offset": {
|
|
4796
|
+
"type": "integer",
|
|
4797
|
+
"description": "Holdings to skip, 0-100000, default 0"
|
|
4798
|
+
}
|
|
4799
|
+
},
|
|
4800
|
+
"required": [
|
|
4801
|
+
"cik"
|
|
4802
|
+
]
|
|
4803
|
+
},
|
|
4804
|
+
"example": {
|
|
4805
|
+
"cik": "1067983"
|
|
4806
|
+
}
|
|
4807
|
+
},
|
|
2942
4808
|
{
|
|
2943
4809
|
"name": "physical_mail_order",
|
|
2944
4810
|
"method": "GET",
|
|
@@ -3000,15 +4866,119 @@ export const ROUTE_MANIFEST = [
|
|
|
3000
4866
|
"properties": {
|
|
3001
4867
|
"phone_number_id": {
|
|
3002
4868
|
"type": "string",
|
|
3003
|
-
"description": "Number id from oneshot_voice_numbers"
|
|
4869
|
+
"description": "Number id from oneshot_voice_numbers"
|
|
4870
|
+
}
|
|
4871
|
+
},
|
|
4872
|
+
"required": [
|
|
4873
|
+
"phone_number_id"
|
|
4874
|
+
]
|
|
4875
|
+
},
|
|
4876
|
+
"example": {
|
|
4877
|
+
"phone_number_id": "pn_01HX"
|
|
4878
|
+
}
|
|
4879
|
+
},
|
|
4880
|
+
{
|
|
4881
|
+
"name": "company_insider_trades",
|
|
4882
|
+
"method": "POST",
|
|
4883
|
+
"path": "/v1/tools/lookup/company-insider-trades",
|
|
4884
|
+
"paid": true,
|
|
4885
|
+
"readOnly": true,
|
|
4886
|
+
"title": "Insider Trades",
|
|
4887
|
+
"description": "Look up a company’s reported insider transactions by issuer CIK or exact ticker: insiders and roles, filing dates, transaction codes, shares and prices. For example, “Which insiders bought or sold GFS?” or “Show transaction amounts, beyond the filing documents listed by company_filings.” Quarterly Forms 3, 4 and 5 transaction filings, posted about a week after each quarter ends. The current quarter’s filings are not yet included. Filings without transaction rows are excluded. All reporting owners of a filing accompany its transactions; the source does not assign individual transaction rows to individual owners.",
|
|
4888
|
+
"inputSchema": {
|
|
4889
|
+
"type": "object",
|
|
4890
|
+
"properties": {
|
|
4891
|
+
"cik": {
|
|
4892
|
+
"type": "string",
|
|
4893
|
+
"description": "Issuer CIK, 1 to 10 digits; exactly one of cik or ticker is required"
|
|
4894
|
+
},
|
|
4895
|
+
"ticker": {
|
|
4896
|
+
"type": "string",
|
|
4897
|
+
"description": "Exact issuer ticker, case insensitive; exactly one of ticker or cik is required"
|
|
4898
|
+
},
|
|
4899
|
+
"filed_after": {
|
|
4900
|
+
"type": "string",
|
|
4901
|
+
"description": "First filing date inclusive, YYYY-MM-DD"
|
|
4902
|
+
},
|
|
4903
|
+
"filed_before": {
|
|
4904
|
+
"type": "string",
|
|
4905
|
+
"description": "Last filing date inclusive, YYYY-MM-DD"
|
|
4906
|
+
},
|
|
4907
|
+
"code": {
|
|
4908
|
+
"type": "string",
|
|
4909
|
+
"description": "Transaction code, such as P or S"
|
|
4910
|
+
},
|
|
4911
|
+
"limit": {
|
|
4912
|
+
"type": "integer",
|
|
4913
|
+
"description": "Page size, 1-100, default 25"
|
|
4914
|
+
},
|
|
4915
|
+
"offset": {
|
|
4916
|
+
"type": "integer",
|
|
4917
|
+
"description": "Transactions to skip, 0-10000, default 0"
|
|
4918
|
+
}
|
|
4919
|
+
},
|
|
4920
|
+
"required": []
|
|
4921
|
+
},
|
|
4922
|
+
"example": {
|
|
4923
|
+
"cik": "1709048"
|
|
4924
|
+
}
|
|
4925
|
+
},
|
|
4926
|
+
{
|
|
4927
|
+
"name": "ledger_bank_transactions",
|
|
4928
|
+
"method": "POST",
|
|
4929
|
+
"path": "/v1/tools/ledger/bank_transactions",
|
|
4930
|
+
"paid": true,
|
|
4931
|
+
"readOnly": true,
|
|
4932
|
+
"title": "Ledger bank transactions",
|
|
4933
|
+
"description": "Bank account lines from a connected accounting system over a period of at most 366 days: date, bank account, counterparty, description, reference, amount with its direction (in or out), `reconciled` (whether the line is matched off against the bank statement) and `has_attachment` (whether a receipt or document is attached), plus the bank accounts seen so the next read can be narrowed with bank_account_id. Xero: every line carries both flags, and both filters apply. QuickBooks: `has_attachment` comes from its attachment records; `reconciled` is null on every line because QuickBooks does not say it per line, the `reconciled: true` filter lists its matched lines only, and `reconciled: false` is refused as unsupported_for_system before payment. Zoho Books and NetSuite bank transactions are not supported and are refused as unsupported_for_system before payment. Read-only. Nothing fetched is stored. Paid per read. Call oneshot_connections_list first and pick the connection_id by system and account_label.",
|
|
4934
|
+
"inputSchema": {
|
|
4935
|
+
"type": "object",
|
|
4936
|
+
"properties": {
|
|
4937
|
+
"connection_id": {
|
|
4938
|
+
"type": "string",
|
|
4939
|
+
"description": "The connection to read. An agent can have several connections to the same system: list your connections first (`GET /v1/connections`) and pick by `system` and `account_label`."
|
|
4940
|
+
},
|
|
4941
|
+
"limit": {
|
|
4942
|
+
"type": "number",
|
|
4943
|
+
"description": "Records per page (1 to 100, default 25)"
|
|
4944
|
+
},
|
|
4945
|
+
"cursor": {
|
|
4946
|
+
"type": "string",
|
|
4947
|
+
"description": "The next_cursor of the previous page"
|
|
4948
|
+
},
|
|
4949
|
+
"from": {
|
|
4950
|
+
"type": "string",
|
|
4951
|
+
"description": "The first day of the period (YYYY-MM-DD)"
|
|
4952
|
+
},
|
|
4953
|
+
"to": {
|
|
4954
|
+
"type": "string",
|
|
4955
|
+
"description": "The last day of the period (YYYY-MM-DD), at most 366 days after from"
|
|
4956
|
+
},
|
|
4957
|
+
"bank_account_id": {
|
|
4958
|
+
"type": "string",
|
|
4959
|
+
"description": "Only the lines of this bank account: an id from the bank_accounts of an earlier answer"
|
|
4960
|
+
},
|
|
4961
|
+
"reconciled": {
|
|
4962
|
+
"type": "boolean",
|
|
4963
|
+
"description": "true: only lines matched off against the bank statement; false: only lines not yet matched (Xero only). Left out: both"
|
|
4964
|
+
},
|
|
4965
|
+
"missing_attachment": {
|
|
4966
|
+
"type": "boolean",
|
|
4967
|
+
"description": "true: only lines with no receipt or document attached. Left out or false: every line"
|
|
3004
4968
|
}
|
|
3005
4969
|
},
|
|
3006
4970
|
"required": [
|
|
3007
|
-
"
|
|
4971
|
+
"connection_id",
|
|
4972
|
+
"from",
|
|
4973
|
+
"to"
|
|
3008
4974
|
]
|
|
3009
4975
|
},
|
|
3010
4976
|
"example": {
|
|
3011
|
-
"
|
|
4977
|
+
"connection_id": "5f4a3b2c-1d0e-4f9a-8b7c-6d5e4f3a2b1c",
|
|
4978
|
+
"from": "2026-09-01",
|
|
4979
|
+
"to": "2026-09-30",
|
|
4980
|
+
"missing_attachment": true,
|
|
4981
|
+
"limit": 25
|
|
3012
4982
|
}
|
|
3013
4983
|
},
|
|
3014
4984
|
{
|
|
@@ -3067,6 +5037,62 @@ export const ROUTE_MANIFEST = [
|
|
|
3067
5037
|
"limit": 25
|
|
3068
5038
|
}
|
|
3069
5039
|
},
|
|
5040
|
+
{
|
|
5041
|
+
"name": "ledger_invoice_lines",
|
|
5042
|
+
"method": "POST",
|
|
5043
|
+
"path": "/v1/tools/ledger/invoice-lines",
|
|
5044
|
+
"paid": true,
|
|
5045
|
+
"readOnly": true,
|
|
5046
|
+
"title": "Ledger invoice lines",
|
|
5047
|
+
"description": "Invoice and credit memo item lines from NetSuite: invoice, issue date, counterparty, item, quantity, amount and currency. Sold units are positive; credit memo quantity and amount are negative. Voided transactions and non-item lines are excluded. Required invoice dates from/to must be at most 400 days apart; up to 500 lines per page. No aggregation: group by customer, item or month yourself. QuickBooks, Xero and Zoho Books invoice lines are not supported and are refused as unsupported_for_system before payment. Read-only. Nothing fetched is stored. Paid per read. Call oneshot_connections_list first and pick the connection_id by system and account_label.",
|
|
5048
|
+
"inputSchema": {
|
|
5049
|
+
"type": "object",
|
|
5050
|
+
"properties": {
|
|
5051
|
+
"connection_id": {
|
|
5052
|
+
"type": "string",
|
|
5053
|
+
"description": "The connection to read. An agent can have several connections to the same system: list your connections first (`GET /v1/connections`) and pick by `system` and `account_label`."
|
|
5054
|
+
},
|
|
5055
|
+
"limit": {
|
|
5056
|
+
"type": "integer",
|
|
5057
|
+
"minimum": 1,
|
|
5058
|
+
"maximum": 500,
|
|
5059
|
+
"default": 25,
|
|
5060
|
+
"description": "Lines per page (1 to 500, default 25); keep the same limit when paging"
|
|
5061
|
+
},
|
|
5062
|
+
"cursor": {
|
|
5063
|
+
"type": "string",
|
|
5064
|
+
"description": "The next_cursor of the previous page"
|
|
5065
|
+
},
|
|
5066
|
+
"from": {
|
|
5067
|
+
"type": "string",
|
|
5068
|
+
"description": "Invoice date on or after this date (YYYY-MM-DD)"
|
|
5069
|
+
},
|
|
5070
|
+
"to": {
|
|
5071
|
+
"type": "string",
|
|
5072
|
+
"description": "Invoice date on or before this date, at most 400 days after from"
|
|
5073
|
+
},
|
|
5074
|
+
"counterparty": {
|
|
5075
|
+
"type": "string",
|
|
5076
|
+
"description": "Only records whose counterparty name contains this text"
|
|
5077
|
+
},
|
|
5078
|
+
"item": {
|
|
5079
|
+
"type": "string",
|
|
5080
|
+
"description": "Only lines whose item name contains this text"
|
|
5081
|
+
}
|
|
5082
|
+
},
|
|
5083
|
+
"required": [
|
|
5084
|
+
"connection_id",
|
|
5085
|
+
"from",
|
|
5086
|
+
"to"
|
|
5087
|
+
]
|
|
5088
|
+
},
|
|
5089
|
+
"example": {
|
|
5090
|
+
"connection_id": "5f4a3b2c-1d0e-4f9a-8b7c-6d5e4f3a2b1c",
|
|
5091
|
+
"from": "2026-09-01",
|
|
5092
|
+
"to": "2026-09-30",
|
|
5093
|
+
"limit": 25
|
|
5094
|
+
}
|
|
5095
|
+
},
|
|
3070
5096
|
{
|
|
3071
5097
|
"name": "ledger_invoices",
|
|
3072
5098
|
"method": "POST",
|
|
@@ -3130,7 +5156,7 @@ export const ROUTE_MANIFEST = [
|
|
|
3130
5156
|
"paid": true,
|
|
3131
5157
|
"readOnly": true,
|
|
3132
5158
|
"title": "Ledger reports",
|
|
3133
|
-
"description": "A report from a connected accounting system. QuickBooks: balance_sheet, profit_and_loss and trial_balance, dated with as_of or from/to. Xero: the same three, with a profit_and_loss of at most 365 days. Zoho Books:
|
|
5159
|
+
"description": "A report from a connected accounting system. QuickBooks: balance_sheet, profit_and_loss and trial_balance, dated with as_of or from/to. Xero: the same three, with a profit_and_loss of at most 365 days. Zoho Books: the same three, with a profit_and_loss that needs from. NetSuite reports are not supported. A report the system does not serve is refused as unsupported_for_system before payment. Read-only. Nothing fetched is stored. Paid per read. Call oneshot_connections_list first and pick the connection_id by system and account_label.",
|
|
3134
5160
|
"inputSchema": {
|
|
3135
5161
|
"type": "object",
|
|
3136
5162
|
"properties": {
|
|
@@ -3153,11 +5179,11 @@ export const ROUTE_MANIFEST = [
|
|
|
3153
5179
|
"profit_and_loss",
|
|
3154
5180
|
"trial_balance"
|
|
3155
5181
|
],
|
|
3156
|
-
"description": "The report. QuickBooks and
|
|
5182
|
+
"description": "The report. QuickBooks, Xero and Zoho Books: all three (Zoho Books: profit_and_loss needs from). NetSuite: no reports"
|
|
3157
5183
|
},
|
|
3158
5184
|
"as_of": {
|
|
3159
5185
|
"type": "string",
|
|
3160
|
-
"description": "Balance sheet and trial balance: the date the report stands at (YYYY-MM-DD)
|
|
5186
|
+
"description": "Balance sheet and trial balance: the date the report stands at (YYYY-MM-DD); today when left out"
|
|
3161
5187
|
},
|
|
3162
5188
|
"from": {
|
|
3163
5189
|
"type": "string",
|
|
@@ -3218,6 +5244,106 @@ export const ROUTE_MANIFEST = [
|
|
|
3218
5244
|
},
|
|
3219
5245
|
"example": {}
|
|
3220
5246
|
},
|
|
5247
|
+
{
|
|
5248
|
+
"name": "mailbox_attachment",
|
|
5249
|
+
"method": "POST",
|
|
5250
|
+
"path": "/v1/tools/mailbox/attachment",
|
|
5251
|
+
"paid": true,
|
|
5252
|
+
"readOnly": true,
|
|
5253
|
+
"title": "Mailbox attachment",
|
|
5254
|
+
"description": "Read content inline, at most 10 MB. Gmail supports attachments included in the message MIME payload; external attachments are not supported yet. Known oversized content is refused before payment. Nothing fetched is stored. Paid per read. Call oneshot_connections_list first and pick the connection_id by system and account_label.",
|
|
5255
|
+
"inputSchema": {
|
|
5256
|
+
"type": "object",
|
|
5257
|
+
"properties": {
|
|
5258
|
+
"connection_id": {
|
|
5259
|
+
"type": "string",
|
|
5260
|
+
"format": "uuid",
|
|
5261
|
+
"description": "List GET /v1/connections first and choose by system and account_label."
|
|
5262
|
+
},
|
|
5263
|
+
"message_id": {
|
|
5264
|
+
"type": "string"
|
|
5265
|
+
},
|
|
5266
|
+
"attachment_id": {
|
|
5267
|
+
"type": "string"
|
|
5268
|
+
}
|
|
5269
|
+
},
|
|
5270
|
+
"required": [
|
|
5271
|
+
"connection_id",
|
|
5272
|
+
"message_id",
|
|
5273
|
+
"attachment_id"
|
|
5274
|
+
]
|
|
5275
|
+
},
|
|
5276
|
+
"example": {
|
|
5277
|
+
"connection_id": "00000000-0000-4000-8000-000000000001",
|
|
5278
|
+
"message_id": "message-1",
|
|
5279
|
+
"attachment_id": "attachment-1"
|
|
5280
|
+
}
|
|
5281
|
+
},
|
|
5282
|
+
{
|
|
5283
|
+
"name": "mailbox_messages",
|
|
5284
|
+
"method": "POST",
|
|
5285
|
+
"path": "/v1/tools/mailbox/messages",
|
|
5286
|
+
"paid": true,
|
|
5287
|
+
"readOnly": true,
|
|
5288
|
+
"title": "Mailbox messages",
|
|
5289
|
+
"description": "Search message snippets and attachment metadata on the chosen connection. At most 50 rows. Nothing fetched is stored. Paid per read. Call oneshot_connections_list first and pick the connection_id by system and account_label.",
|
|
5290
|
+
"inputSchema": {
|
|
5291
|
+
"type": "object",
|
|
5292
|
+
"properties": {
|
|
5293
|
+
"connection_id": {
|
|
5294
|
+
"type": "string",
|
|
5295
|
+
"format": "uuid",
|
|
5296
|
+
"description": "List GET /v1/connections first and choose by system and account_label."
|
|
5297
|
+
},
|
|
5298
|
+
"query": {
|
|
5299
|
+
"type": "string",
|
|
5300
|
+
"minLength": 1,
|
|
5301
|
+
"maxLength": 500,
|
|
5302
|
+
"description": "Required search text. Keep the same filters when paging."
|
|
5303
|
+
},
|
|
5304
|
+
"limit": {
|
|
5305
|
+
"type": "integer",
|
|
5306
|
+
"minimum": 1,
|
|
5307
|
+
"maximum": 50,
|
|
5308
|
+
"default": 25
|
|
5309
|
+
},
|
|
5310
|
+
"cursor": {
|
|
5311
|
+
"type": "string",
|
|
5312
|
+
"description": "The next_cursor from the previous page."
|
|
5313
|
+
},
|
|
5314
|
+
"from": {
|
|
5315
|
+
"type": "string",
|
|
5316
|
+
"format": "date",
|
|
5317
|
+
"description": "Inclusive received date, YYYY-MM-DD."
|
|
5318
|
+
},
|
|
5319
|
+
"to": {
|
|
5320
|
+
"type": "string",
|
|
5321
|
+
"format": "date",
|
|
5322
|
+
"description": "Inclusive received date, YYYY-MM-DD."
|
|
5323
|
+
},
|
|
5324
|
+
"sender": {
|
|
5325
|
+
"type": "string",
|
|
5326
|
+
"format": "email"
|
|
5327
|
+
},
|
|
5328
|
+
"has_attachments": {
|
|
5329
|
+
"type": "boolean"
|
|
5330
|
+
}
|
|
5331
|
+
},
|
|
5332
|
+
"required": [
|
|
5333
|
+
"connection_id",
|
|
5334
|
+
"query",
|
|
5335
|
+
"from",
|
|
5336
|
+
"to"
|
|
5337
|
+
]
|
|
5338
|
+
},
|
|
5339
|
+
"example": {
|
|
5340
|
+
"connection_id": "00000000-0000-4000-8000-000000000001",
|
|
5341
|
+
"query": "invoice",
|
|
5342
|
+
"from": "2026-10-01",
|
|
5343
|
+
"to": "2026-10-31",
|
|
5344
|
+
"limit": 25
|
|
5345
|
+
}
|
|
5346
|
+
},
|
|
3221
5347
|
{
|
|
3222
5348
|
"name": "notifications_mark_all_read",
|
|
3223
5349
|
"method": "PATCH",
|
|
@@ -3233,6 +5359,95 @@ export const ROUTE_MANIFEST = [
|
|
|
3233
5359
|
},
|
|
3234
5360
|
"example": {}
|
|
3235
5361
|
},
|
|
5362
|
+
{
|
|
5363
|
+
"name": "meetings_get",
|
|
5364
|
+
"method": "POST",
|
|
5365
|
+
"path": "/v1/tools/meetings/get",
|
|
5366
|
+
"paid": true,
|
|
5367
|
+
"readOnly": true,
|
|
5368
|
+
"title": "Meetings get",
|
|
5369
|
+
"description": "One meeting from the customer's connected meeting recorder: its summary and action items, and its transcript only when asked for. Read-only; returned inline and never stored. Paid per read. Call oneshot_connections_list first and pick the connection_id by system and account_label.",
|
|
5370
|
+
"inputSchema": {
|
|
5371
|
+
"type": "object",
|
|
5372
|
+
"properties": {
|
|
5373
|
+
"connection_id": {
|
|
5374
|
+
"type": "string",
|
|
5375
|
+
"description": "The connection to read. An agent can have several connections to the same system: list your connections first (`GET /v1/connections`) and pick by `system` and `account_label`."
|
|
5376
|
+
},
|
|
5377
|
+
"meeting_id": {
|
|
5378
|
+
"type": "string",
|
|
5379
|
+
"description": "The id of the meeting, as meetings_list answers it"
|
|
5380
|
+
},
|
|
5381
|
+
"include": {
|
|
5382
|
+
"type": "array",
|
|
5383
|
+
"items": {
|
|
5384
|
+
"type": "string",
|
|
5385
|
+
"enum": [
|
|
5386
|
+
"summary",
|
|
5387
|
+
"action_items",
|
|
5388
|
+
"transcript"
|
|
5389
|
+
]
|
|
5390
|
+
},
|
|
5391
|
+
"description": "What to read besides the meeting itself (default summary and action_items); the transcript only when asked for"
|
|
5392
|
+
}
|
|
5393
|
+
},
|
|
5394
|
+
"required": [
|
|
5395
|
+
"connection_id",
|
|
5396
|
+
"meeting_id"
|
|
5397
|
+
]
|
|
5398
|
+
},
|
|
5399
|
+
"example": {
|
|
5400
|
+
"connection_id": "6f1c2d3e-4b5a-4c6d-8e7f-9a0b1c2d3e4f",
|
|
5401
|
+
"meeting_id": "0dba4400-0000-4000-8000-000000000001",
|
|
5402
|
+
"include": [
|
|
5403
|
+
"summary",
|
|
5404
|
+
"action_items"
|
|
5405
|
+
]
|
|
5406
|
+
}
|
|
5407
|
+
},
|
|
5408
|
+
{
|
|
5409
|
+
"name": "meetings_list",
|
|
5410
|
+
"method": "POST",
|
|
5411
|
+
"path": "/v1/tools/meetings/list",
|
|
5412
|
+
"paid": true,
|
|
5413
|
+
"readOnly": true,
|
|
5414
|
+
"title": "Meetings list",
|
|
5415
|
+
"description": "Meetings recorded by the customer's connected meeting recorder, with title, start, duration and participants, filtered by start day and by title or participant. Read-only. Paid per read. Call oneshot_connections_list first and pick the connection_id by system and account_label.",
|
|
5416
|
+
"inputSchema": {
|
|
5417
|
+
"type": "object",
|
|
5418
|
+
"properties": {
|
|
5419
|
+
"connection_id": {
|
|
5420
|
+
"type": "string",
|
|
5421
|
+
"description": "The connection to read. An agent can have several connections to the same system: list your connections first (`GET /v1/connections`) and pick by `system` and `account_label`."
|
|
5422
|
+
},
|
|
5423
|
+
"since": {
|
|
5424
|
+
"type": "string",
|
|
5425
|
+
"description": "Meetings that started on or after this day (YYYY-MM-DD, UTC)"
|
|
5426
|
+
},
|
|
5427
|
+
"query": {
|
|
5428
|
+
"type": "string",
|
|
5429
|
+
"description": "Meetings whose title, or a participant's name or email, contains this text (any case)"
|
|
5430
|
+
},
|
|
5431
|
+
"limit": {
|
|
5432
|
+
"type": "integer",
|
|
5433
|
+
"description": "Meetings per page, 1 to 100 (default 25)"
|
|
5434
|
+
},
|
|
5435
|
+
"cursor": {
|
|
5436
|
+
"type": "string",
|
|
5437
|
+
"description": "The next_cursor of the previous page"
|
|
5438
|
+
}
|
|
5439
|
+
},
|
|
5440
|
+
"required": [
|
|
5441
|
+
"connection_id"
|
|
5442
|
+
]
|
|
5443
|
+
},
|
|
5444
|
+
"example": {
|
|
5445
|
+
"connection_id": "6f1c2d3e-4b5a-4c6d-8e7f-9a0b1c2d3e4f",
|
|
5446
|
+
"since": "2026-10-01",
|
|
5447
|
+
"query": "client",
|
|
5448
|
+
"limit": 25
|
|
5449
|
+
}
|
|
5450
|
+
},
|
|
3236
5451
|
{
|
|
3237
5452
|
"name": "physical_mail_preview",
|
|
3238
5453
|
"method": "POST",
|
|
@@ -3286,6 +5501,46 @@ export const ROUTE_MANIFEST = [
|
|
|
3286
5501
|
}
|
|
3287
5502
|
}
|
|
3288
5503
|
},
|
|
5504
|
+
{
|
|
5505
|
+
"name": "company_private_raises",
|
|
5506
|
+
"method": "POST",
|
|
5507
|
+
"path": "/v1/tools/lookup/company-private-raises",
|
|
5508
|
+
"paid": true,
|
|
5509
|
+
"readOnly": true,
|
|
5510
|
+
"title": "Private Raises",
|
|
5511
|
+
"description": "Look up a company’s private offerings by issuer CIK from its Form D and D/A notices: amounts sought, sold and remaining, exemption, security types, industry, investor counts and related persons. For example, “How much has Southview Timberland Fund raised privately and under which exemption?” or “Show the amounts and investors behind a Form D, beyond the filing documents listed by company_filings.” Quarterly Form D and D/A notices of exempt offerings, posted about a week after each quarter ends. The current quarter’s notices are not yet included. Amendments are listed as their own notices with previous_accession_number, so the newest notice of an offering carries its latest figures. Issuer and related-person street addresses, ZIP codes and phone numbers are excluded.",
|
|
5512
|
+
"inputSchema": {
|
|
5513
|
+
"type": "object",
|
|
5514
|
+
"properties": {
|
|
5515
|
+
"cik": {
|
|
5516
|
+
"type": "string",
|
|
5517
|
+
"description": "Issuer CIK, 1 to 10 digits"
|
|
5518
|
+
},
|
|
5519
|
+
"filed_after": {
|
|
5520
|
+
"type": "string",
|
|
5521
|
+
"description": "First filing date inclusive, YYYY-MM-DD"
|
|
5522
|
+
},
|
|
5523
|
+
"filed_before": {
|
|
5524
|
+
"type": "string",
|
|
5525
|
+
"description": "Last filing date inclusive, YYYY-MM-DD"
|
|
5526
|
+
},
|
|
5527
|
+
"limit": {
|
|
5528
|
+
"type": "integer",
|
|
5529
|
+
"description": "Page size, 1-50, default 20"
|
|
5530
|
+
},
|
|
5531
|
+
"offset": {
|
|
5532
|
+
"type": "integer",
|
|
5533
|
+
"description": "Notices to skip, 0-10000, default 0"
|
|
5534
|
+
}
|
|
5535
|
+
},
|
|
5536
|
+
"required": [
|
|
5537
|
+
"cik"
|
|
5538
|
+
]
|
|
5539
|
+
},
|
|
5540
|
+
"example": {
|
|
5541
|
+
"cik": "1991882"
|
|
5542
|
+
}
|
|
5543
|
+
},
|
|
3289
5544
|
{
|
|
3290
5545
|
"name": "procurement_bills",
|
|
3291
5546
|
"method": "POST",
|
|
@@ -3412,6 +5667,67 @@ export const ROUTE_MANIFEST = [
|
|
|
3412
5667
|
"limit": 25
|
|
3413
5668
|
}
|
|
3414
5669
|
},
|
|
5670
|
+
{
|
|
5671
|
+
"name": "company_radio_licenses",
|
|
5672
|
+
"method": "POST",
|
|
5673
|
+
"path": "/v1/tools/lookup/company-radio-licenses",
|
|
5674
|
+
"paid": true,
|
|
5675
|
+
"readOnly": true,
|
|
5676
|
+
"title": "Radio Licenses",
|
|
5677
|
+
"description": "Find a company's active radio licences by FRN, call sign or exact folded legal name. For example, “Which paging licences does AMS Spectrum Holdings hold?” or “Find spectrum licences for a company's radio fleet; company_contractor_license covers trade credentials.” Returns call signs, services, status, dates and business licensee details. Active company FCC licences in private and commercial land mobile, microwave, market-based spectrum, cellular and paging services, loaded from weekly complete files. Individual licensees are excluded. Records with no company name and malformed records are also excluded. No match says nothing about other services or expired licences.",
|
|
5678
|
+
"inputSchema": {
|
|
5679
|
+
"type": "object",
|
|
5680
|
+
"properties": {
|
|
5681
|
+
"frn": {
|
|
5682
|
+
"type": "string",
|
|
5683
|
+
"pattern": "^[0-9]{10}$",
|
|
5684
|
+
"description": "FCC Registration Number, exactly ten digits; supply exactly one identifier"
|
|
5685
|
+
},
|
|
5686
|
+
"call_sign": {
|
|
5687
|
+
"type": "string",
|
|
5688
|
+
"description": "FCC call sign; supply exactly one identifier"
|
|
5689
|
+
},
|
|
5690
|
+
"licensee_name": {
|
|
5691
|
+
"type": "string",
|
|
5692
|
+
"description": "Exact legal name after case, punctuation and legal suffix folding; supply exactly one identifier"
|
|
5693
|
+
},
|
|
5694
|
+
"service": {
|
|
5695
|
+
"type": "string",
|
|
5696
|
+
"enum": [
|
|
5697
|
+
"LMpriv",
|
|
5698
|
+
"LMcomm",
|
|
5699
|
+
"micro",
|
|
5700
|
+
"market",
|
|
5701
|
+
"cell",
|
|
5702
|
+
"paging"
|
|
5703
|
+
],
|
|
5704
|
+
"description": "Weekly service file to search; omit to check all six"
|
|
5705
|
+
},
|
|
5706
|
+
"expiring_before": {
|
|
5707
|
+
"type": "string",
|
|
5708
|
+
"format": "date",
|
|
5709
|
+
"description": "Expiration strictly before this real YYYY-MM-DD date"
|
|
5710
|
+
},
|
|
5711
|
+
"limit": {
|
|
5712
|
+
"type": "integer",
|
|
5713
|
+
"minimum": 1,
|
|
5714
|
+
"maximum": 100,
|
|
5715
|
+
"description": "Page size, default 50"
|
|
5716
|
+
},
|
|
5717
|
+
"offset": {
|
|
5718
|
+
"type": "integer",
|
|
5719
|
+
"minimum": 0,
|
|
5720
|
+
"maximum": 10000,
|
|
5721
|
+
"description": "Results to skip, default 0"
|
|
5722
|
+
}
|
|
5723
|
+
},
|
|
5724
|
+
"required": []
|
|
5725
|
+
},
|
|
5726
|
+
"example": {
|
|
5727
|
+
"frn": "0019131390",
|
|
5728
|
+
"service": "paging"
|
|
5729
|
+
}
|
|
5730
|
+
},
|
|
3415
5731
|
{
|
|
3416
5732
|
"name": "physical_mail_recover",
|
|
3417
5733
|
"method": "GET",
|