Skip to content

Commit 276f36c

Browse files
EricGustinbyrro
EricGustin
and
byrro
authored
Add Finance, Flights, Hotels, Maps, Jobs, News Toolkit Docs (#193)
* document google maps tools * Add google finance, flights, hotels * Add google maps image * Enum * Fix image name * Transparent images * merge google jobs docs * google jobs icon * merge google news * fix arg annotation in google-jobs * document default language for google-jobs tools * add language and country codes to search reference * fix titles * fix reference to default parameter in google-jobs * fix reference to google jobs * fix google-news examples * fix limit default value * default env var parameter values for google maps tools * Google icon and auth secret docs * REsolve conflict --------- Co-authored-by: Renato Byrro <[email protected]>
1 parent d070707 commit 276f36c

File tree

58 files changed

+1946
-19
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+1946
-19
lines changed

‎pages/toolkits/_meta.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ export default {
2121
development: {
2222
title: "Developer Tools",
2323
},
24+
search: {
25+
title: "Search Tools",
26+
},
2427
"-- Submit your toolkit": {
2528
type: "separator",
2629
title: "Submit your toolkit",

‎pages/toolkits/search/google_finance.mdx‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
# Google Finance
2+
3+
import ToolInfo from "@/components/ToolInfo";
4+
import Badges from "@/components/Badges";
5+
import TabbedCodeBlock from "@/components/TabbedCodeBlock";
6+
import TableOfContents from "@/components/TableOfContents";
7+
8+
<ToolInfo
9+
description="Empower your agents to retrieve stock data using Arcade."
10+
author="Arcade"
11+
codeLink="https://github.com/ArcadeAI/arcade-ai/tree/main/toolkits/search"
12+
authType="API Key"
13+
versions={['0.1.0']}
14+
/>
15+
16+
<Badges repo="arcadeai/search" />
17+
18+
The Arcade Google Finance toolkit lets you fetch real-time and historical stock data with ease. Use these tools to build intelligent agents and applications that fetch:
19+
20+
- Stock summary data.
21+
- Historical stock data.
22+
23+
## Install
24+
25+
```bash
26+
pip install arcade_search
27+
```
28+
29+
<Note>
30+
pip installing the toolkit is only needed if you are [self-hosting](/home/install/overview) Arcade. You do not need to install the toolkit if you're using Arcade Cloud.
31+
</Note>
32+
33+
## Available Tools
34+
35+
<TableOfContents
36+
headers={['Tool Name', 'Description']}
37+
data={
38+
[
39+
['GetStockSummary', "Retrieve current price and recent price movement of a stock."],
40+
['GetStockHistoricalData', "Fetch historical stock price and volume data for a specified time window."]
41+
]
42+
}
43+
/>
44+
45+
<Tip>
46+
If you need an action that's not listed here, please [contact us](mailto:[email protected]) to request a new tool, or [create your own tools](/home/build-tools/create-a-toolkit).
47+
</Tip>
48+
49+
## GetStockSummary
50+
51+
Retrieve summary information for a given stock using the Google Finance API via SerpAPI. This tool returns the current price and price change from the most recent trading day.
52+
53+
**Parameters**
54+
55+
- **`ticker_symbol`** _(string, required)_: The stock ticker, e.g., 'GOOG'.
56+
- **`exchange_identifier`** _(string, required)_: The market identifier, e.g., 'NASDAQ'.
57+
58+
<br />
59+
<TabbedCodeBlock
60+
tabs={[
61+
{
62+
label: "Call the Tool Directly",
63+
content: {
64+
Python: [
65+
"/examples/integrations/toolkits/search/google_finance/get_stock_summary_example_call_tool.py",
66+
],
67+
JavaScript: ["/examples/integrations/toolkits/search/google_finance/get_stock_summary_example_call_tool.js"],
68+
},
69+
},
70+
{
71+
label: "Execute the Tool with OpenAI",
72+
content: {
73+
Python: [
74+
"/examples/integrations/toolkits/search/google_finance/get_stock_summary_example_llm_oai.py",
75+
],
76+
JavaScript: ["/examples/integrations/toolkits/search/google_finance/get_stock_summary_example_llm_oai.js"],
77+
},
78+
},
79+
]}
80+
/>
81+
82+
## GetStockHistoricalData
83+
84+
Fetch historical data for a given stock over a defined time window. This tool returns the stock's price and volume data along with key events when available.
85+
86+
**Parameters**
87+
88+
- **`ticker_symbol`** _(string, required)_: The stock ticker, e.g., 'GOOG'.
89+
- **`exchange_identifier`** _(string, required)_: The market identifier, e.g., 'NASDAQ' or 'NYSE'.
90+
- **`window`** _(enum ([GoogleFinanceWindow](/toolkits/search/reference#googlefinancewindow)), optional, defaults to ONE_MONTH)_: Time window for the graph data.
91+
92+
<br />
93+
<TabbedCodeBlock
94+
tabs={[
95+
{
96+
label: "Call the Tool Directly",
97+
content: {
98+
Python: [
99+
"/examples/integrations/toolkits/search/google_finance/get_stock_historical_data_example_call_tool.py",
100+
],
101+
JavaScript: ["/examples/integrations/toolkits/search/google_finance/get_stock_historical_data_example_call_tool.js"],
102+
},
103+
},
104+
{
105+
label: "Execute the Tool with OpenAI",
106+
content: {
107+
Python: [
108+
"/examples/integrations/toolkits/search/google_finance/get_stock_historical_data_example_llm_oai.py",
109+
],
110+
JavaScript: ["/examples/integrations/toolkits/search/google_finance/get_stock_historical_data_example_llm_oai.js"],
111+
},
112+
},
113+
]}
114+
/>
115+
116+
## Auth
117+
118+
The Arcade Google Finance toolkit uses the [SerpAPI](https://serpapi.com/) to get stock data from Google Finance.
119+
120+
- **Secret:**
121+
- `SERP_API_KEY`: Your SerpAPI API key.
122+
<Note>
123+
Setting the `SERP_API_KEY` secret is only required if you are [self-hosting](/home/install/overview) Arcade. If you're using Arcade Cloud, the secret is already set for you. To manage your secrets, go to the [Secrets page](https://api.arcade.dev/dashboard/auth/secrets) in the Arcade Dashboard.
124+
</Note>

‎pages/toolkits/search/google_flights.mdx‎

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
# Google Flights
2+
3+
import ToolInfo from "@/components/ToolInfo";
4+
import Badges from "@/components/Badges";
5+
import TabbedCodeBlock from "@/components/TabbedCodeBlock";
6+
import TableOfContents from "@/components/TableOfContents";
7+
8+
<ToolInfo
9+
description="Empower your agents to search for flights using Arcade."
10+
author="Arcade"
11+
codeLink="https://github.com/ArcadeAI/arcade-ai/tree/main/toolkits/search"
12+
authType="API Key"
13+
versions={['0.1.0']}
14+
/>
15+
16+
<Badges repo="arcadeai/search" />
17+
18+
The Arcade Google Flights toolkit lets you search for flights with ease. Use these tools to build intelligent agents and applications that:
19+
20+
- Search for round-trip flights.
21+
- Search for one-way flights.
22+
23+
## Install
24+
25+
```bash
26+
pip install arcade_search
27+
```
28+
29+
<Note>
30+
pip installing the toolkit is only needed if you are [self-hosting](/home/install/overview) Arcade. You do not need to install the toolkit if you're using Arcade Cloud.
31+
</Note>
32+
33+
## Available Tools
34+
35+
<TableOfContents
36+
headers={['Tool Name', 'Description']}
37+
data={
38+
[
39+
['SearchRoundtripFlights', "Retrieve roundtrip flight search results using Google Flights."],
40+
['SearchOneWayFlights', "Retrieve one-way flight search results using Google Flights."]
41+
]
42+
}
43+
/>
44+
45+
## SearchRoundtripFlights
46+
47+
Retrieve flight search results using Google Flights.
48+
49+
**Parameters**
50+
51+
- **`departure_airport_code`** _(string, required)_: The departure airport code. An uppercase 3-letter code.
52+
- **`arrival_airport_code`** _(string, required)_: The arrival airport code. An uppercase 3-letter code.
53+
- **`outbound_date`** _(string, required)_: Flight outbound date in YYYY-MM-DD format.
54+
- **`return_date`** _(string, optional)_: Flight return date in YYYY-MM-DD format.
55+
- **`currency_code`** _(string, optional)_: Currency of the returned prices. Defaults to 'USD'.
56+
- **`travel_class`** _(enum ([GoogleFlightsTravelClass](/toolkits/search/reference#googleflightstravelclass)), optional)_: Travel class of the flight. Defaults to 'ECONOMY'.
57+
- **`num_adults`** _(int, optional)_: Number of adult passengers. Defaults to 1.
58+
- **`num_children`** _(int, optional)_: Number of child passengers. Defaults to 0.
59+
- **`max_stops`** _(enum ([GoogleFlightsMaxStops](/toolkits/search/reference#googleflightsmaxstops)), optional)_: Maximum number of stops (layovers) for the flight. Defaults to any number of stops.
60+
- **`sort_by`** _(enum ([GoogleFlightsSortBy](/toolkits/search/reference#googleflightssortby)), optional)_: The sorting order of the results. Defaults to TOP_FLIGHTS.
61+
62+
<br />
63+
<TabbedCodeBlock
64+
tabs={[
65+
{
66+
label: "Call the tool directly",
67+
content: {
68+
Python: [
69+
"/examples/integrations/toolkits/search/google_flights/search_roundtrip_flights_example_call_tool.py",
70+
],
71+
JavaScript: ["/examples/integrations/toolkits/search/google_flights/search_roundtrip_flights_example_call_tool.js"],
72+
},
73+
},
74+
{
75+
label: "Execute the tool with OpenAI",
76+
content: {
77+
Python: [
78+
"/examples/integrations/toolkits/search/google_flights/search_roundtrip_flights_example_llm_oai.py",
79+
],
80+
JavaScript: ["/examples/integrations/toolkits/search/google_flights/search_roundtrip_flights_example_llm_oai.js"],
81+
},
82+
},
83+
]}
84+
/>
85+
86+
## SearchOneWayFlights
87+
88+
Retrieve flight search results for a one-way flight using Google Flights.
89+
90+
**Parameters**
91+
92+
- **`departure_airport_code`** _(string, required)_: The departure airport code. An uppercase 3-letter code.
93+
- **`arrival_airport_code`** _(string, required)_: The arrival airport code. An uppercase 3-letter code.
94+
- **`outbound_date`** _(string, required)_: Flight departure date in YYYY-MM-DD format.
95+
- **`currency_code`** _(string, optional)_: Currency of the returned prices. Defaults to 'USD'.
96+
- **`travel_class`** _(enum ([GoogleFlightsTravelClass](/toolkits/search/reference#googleflightstravelclass)), optional)_: Travel class of the flight. Defaults to 'ECONOMY'.
97+
- **`num_adults`** _(int, optional)_: Number of adult passengers. Defaults to 1.
98+
- **`num_children`** _(int, optional)_: Number of child passengers. Defaults to 0.
99+
- **`max_stops`** _(enum ([GoogleFlightsMaxStops](/toolkits/search/reference#googleflightsmaxstops)), optional)_: Maximum number of stops (layovers) for the flight. Defaults to any number of stops.
100+
- **`sort_by`** _(enum ([GoogleFlightsSortBy](/toolkits/search/reference#googleflightssortby)), optional)_: The sorting order of the results. Defaults to TOP_FLIGHTS.
101+
102+
<br />
103+
<TabbedCodeBlock
104+
tabs={[
105+
{
106+
label: "Call the tool directly",
107+
content: {
108+
Python: [
109+
"/examples/integrations/toolkits/search/google_flights/search_one_way_flights_example_call_tool.py",
110+
],
111+
JavaScript: ["/examples/integrations/toolkits/search/google_flights/search_one_way_flights_example_call_tool.js"],
112+
},
113+
},
114+
{
115+
label: "Execute the tool with OpenAI",
116+
content: {
117+
Python: [
118+
"/examples/integrations/toolkits/search/google_flights/search_one_way_flights_example_llm_oai.py",
119+
],
120+
JavaScript: ["/examples/integrations/toolkits/search/google_flights/search_one_way_flights_example_llm_oai.js"],
121+
},
122+
},
123+
]}
124+
/>
125+
126+
## Auth
127+
128+
The Arcade Google Flights toolkit uses the [SerpAPI](https://serpapi.com/) to search for flights from Google Flights.
129+
130+
- **Secret:**
131+
- `SERP_API_KEY`: Your SerpAPI API key.
132+
133+
<Note>
134+
Setting the `SERP_API_KEY` secret is only required if you are [self-hosting](/home/install/overview) Arcade. If you're using Arcade Cloud, the secret is already set for you. To manage your secrets, go to the [Secrets page](https://api.arcade.dev/dashboard/auth/secrets) in the Arcade Dashboard.
135+
</Note>

‎pages/toolkits/search/google_hotels.mdx‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Google Hotels
2+
3+
import ToolInfo from "@/components/ToolInfo";
4+
import Badges from "@/components/Badges";
5+
import TabbedCodeBlock from "@/components/TabbedCodeBlock";
6+
import TableOfContents from "@/components/TableOfContents";
7+
8+
<ToolInfo
9+
description="Empower your agents to search for hotels using Arcade."
10+
author="Arcade"
11+
codeLink="https://github.com/ArcadeAI/arcade-ai/tree/main/toolkits/search"
12+
authType="API Key"
13+
versions={['0.1.0']}
14+
/>
15+
16+
<Badges repo="arcadeai/search" />
17+
18+
The Arcade Google Hotels toolkit lets you search for hotels with ease. Use this tool to build intelligent agents and applications that search for hotels worldwide.
19+
20+
## Install
21+
22+
```bash
23+
pip install arcade_search
24+
```
25+
26+
<Note>
27+
pip installing the toolkit is only needed if you are [self-hosting](/home/install/overview) Arcade. You do not need to install the toolkit if you're using Arcade Cloud.
28+
</Note>
29+
30+
## Available Tools
31+
32+
<TableOfContents
33+
headers={['Tool Name', 'Description']}
34+
data={
35+
[
36+
['SearchHotels', "Retrieve hotel search results using the Google Hotels API."]
37+
]
38+
}
39+
/>
40+
41+
## SearchHotels
42+
43+
Retrieve hotel search results using the Google Hotels API.
44+
45+
**Parameters**
46+
47+
- **`location`** _(string, required)_: Location to search for hotels, e.g., a city name, a state, etc.
48+
- **`check_in_date`** _(string, required)_: Check-in date in YYYY-MM-DD format.
49+
- **`check_out_date`** _(string, required)_: Check-out date in YYYY-MM-DD format.
50+
- **`query`** _(string, optional)_: Anything that would be used in a regular Google Hotels search.
51+
- **`currency`** _(string, optional)_: Currency code for prices. Defaults to 'USD'.
52+
- **`min_price`** _(int, optional)_: Minimum price per night. Defaults to no minimum.
53+
- **`max_price`** _(int, optional)_: Maximum price per night. Defaults to no maximum.
54+
- **`num_adults`** _(int, optional)_: Number of adults per room. Defaults to 2.
55+
- **`num_children`** _(int, optional)_: Number of children per room. Defaults to 0.
56+
- **`sort_by`** _(enum ([GoogleHotelsSortBy](/toolkits/search/reference#googlehotelssortby)), optional)_: The sorting order of the results. Defaults to RELEVANCE.
57+
- **`num_results`** _(int, optional)_: Maximum number of results to return. Defaults to 5. Max 20.
58+
59+
<br />
60+
<TabbedCodeBlock
61+
tabs={[
62+
{
63+
label: "Call the tool directly",
64+
content: {
65+
Python: [
66+
"/examples/integrations/toolkits/search/google_hotels/search_hotels_example_call_tool.py",
67+
],
68+
JavaScript: ["/examples/integrations/toolkits/search/google_hotels/search_hotels_example_call_tool.js"],
69+
},
70+
},
71+
{
72+
label: "Execute the tool with OpenAI",
73+
content: {
74+
Python: [
75+
"/examples/integrations/toolkits/search/google_hotels/search_hotels_example_llm_oai.py",
76+
],
77+
JavaScript: ["/examples/integrations/toolkits/search/google_hotels/search_hotels_example_llm_oai.js"],
78+
},
79+
},
80+
]}
81+
/>
82+
83+
## Auth
84+
85+
The Arcade Google Hotels toolkit uses the [SerpAPI](https://serpapi.com/) to search for hotels from Google Hotels.
86+
87+
- **Secret:**
88+
- `SERP_API_KEY`: Your SerpAPI API key.
89+
90+
<Note>
91+
Setting the `SERP_API_KEY` secret is only required if you are [self-hosting](/home/install/overview) Arcade. If you're using Arcade Cloud, the secret is already set for you. To manage your secrets, go to the [Secrets page](https://api.arcade.dev/dashboard/auth/secrets) in the Arcade Dashboard.
92+
</Note>

0 commit comments

Comments
 (0)