Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions pages/toolkits/_meta.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ export default {
development: {
title: "Developer Tools",
},
search: {
title: "Search Tools",
},
"-- Submit your toolkit": {
type: "separator",
title: "Submit your toolkit",
Expand Down
124 changes: 124 additions & 0 deletions pages/toolkits/search/google_finance.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
# Google Finance

import ToolInfo from "@/components/ToolInfo";
import Badges from "@/components/Badges";
import TabbedCodeBlock from "@/components/TabbedCodeBlock";
import TableOfContents from "@/components/TableOfContents";

<ToolInfo
description="Empower your agents to retrieve stock data using Arcade."
author="Arcade"
codeLink="https://github.com/ArcadeAI/arcade-ai/tree/main/toolkits/search"
authType="API Key"
versions={['0.1.0']}
/>

<Badges repo="arcadeai/search" />

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:

- Stock summary data.
- Historical stock data.

## Install

```bash
pip install arcade_search
```

<Note>
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.
</Note>

## Available Tools

<TableOfContents
headers={['Tool Name', 'Description']}
data={
[
['GetStockSummary', "Retrieve current price and recent price movement of a stock."],
['GetStockHistoricalData', "Fetch historical stock price and volume data for a specified time window."]
]
}
/>

<Tip>
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).
</Tip>

## GetStockSummary

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.

**Parameters**

- **`ticker_symbol`** _(string, required)_: The stock ticker, e.g., 'GOOG'.
- **`exchange_identifier`** _(string, required)_: The market identifier, e.g., 'NASDAQ'.

<br />
<TabbedCodeBlock
tabs={[
{
label: "Call the Tool Directly",
content: {
Python: [
"/examples/integrations/toolkits/search/google_finance/get_stock_summary_example_call_tool.py",
],
JavaScript: ["/examples/integrations/toolkits/search/google_finance/get_stock_summary_example_call_tool.js"],
},
},
{
label: "Execute the Tool with OpenAI",
content: {
Python: [
"/examples/integrations/toolkits/search/google_finance/get_stock_summary_example_llm_oai.py",
],
JavaScript: ["/examples/integrations/toolkits/search/google_finance/get_stock_summary_example_llm_oai.js"],
},
},
]}
/>

## GetStockHistoricalData

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.

**Parameters**

- **`ticker_symbol`** _(string, required)_: The stock ticker, e.g., 'GOOG'.
- **`exchange_identifier`** _(string, required)_: The market identifier, e.g., 'NASDAQ' or 'NYSE'.
- **`window`** _(enum ([GoogleFinanceWindow](/toolkits/search/reference#googlefinancewindow)), optional, defaults to ONE_MONTH)_: Time window for the graph data.

<br />
<TabbedCodeBlock
tabs={[
{
label: "Call the Tool Directly",
content: {
Python: [
"/examples/integrations/toolkits/search/google_finance/get_stock_historical_data_example_call_tool.py",
],
JavaScript: ["/examples/integrations/toolkits/search/google_finance/get_stock_historical_data_example_call_tool.js"],
},
},
{
label: "Execute the Tool with OpenAI",
content: {
Python: [
"/examples/integrations/toolkits/search/google_finance/get_stock_historical_data_example_llm_oai.py",
],
JavaScript: ["/examples/integrations/toolkits/search/google_finance/get_stock_historical_data_example_llm_oai.js"],
},
},
]}
/>

## Auth

The Arcade Google Finance toolkit uses the [SerpAPI](https://serpapi.com/) to get stock data from Google Finance.

- **Secret:**
- `SERP_API_KEY`: Your SerpAPI API key.
<Note>
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.
</Note>
135 changes: 135 additions & 0 deletions pages/toolkits/search/google_flights.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
# Google Flights

import ToolInfo from "@/components/ToolInfo";
import Badges from "@/components/Badges";
import TabbedCodeBlock from "@/components/TabbedCodeBlock";
import TableOfContents from "@/components/TableOfContents";

<ToolInfo
description="Empower your agents to search for flights using Arcade."
author="Arcade"
codeLink="https://github.com/ArcadeAI/arcade-ai/tree/main/toolkits/search"
authType="API Key"
versions={['0.1.0']}
/>

<Badges repo="arcadeai/search" />

The Arcade Google Flights toolkit lets you search for flights with ease. Use these tools to build intelligent agents and applications that:

- Search for round-trip flights.
- Search for one-way flights.

## Install

```bash
pip install arcade_search
```

<Note>
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.
</Note>

## Available Tools

<TableOfContents
headers={['Tool Name', 'Description']}
data={
[
['SearchRoundtripFlights', "Retrieve roundtrip flight search results using Google Flights."],
['SearchOneWayFlights', "Retrieve one-way flight search results using Google Flights."]
]
}
/>

## SearchRoundtripFlights

Retrieve flight search results using Google Flights.

**Parameters**

- **`departure_airport_code`** _(string, required)_: The departure airport code. An uppercase 3-letter code.
- **`arrival_airport_code`** _(string, required)_: The arrival airport code. An uppercase 3-letter code.
- **`outbound_date`** _(string, required)_: Flight outbound date in YYYY-MM-DD format.
- **`return_date`** _(string, optional)_: Flight return date in YYYY-MM-DD format.
- **`currency_code`** _(string, optional)_: Currency of the returned prices. Defaults to 'USD'.
- **`travel_class`** _(enum ([GoogleFlightsTravelClass](/toolkits/search/reference#googleflightstravelclass)), optional)_: Travel class of the flight. Defaults to 'ECONOMY'.
- **`num_adults`** _(int, optional)_: Number of adult passengers. Defaults to 1.
- **`num_children`** _(int, optional)_: Number of child passengers. Defaults to 0.
- **`max_stops`** _(enum ([GoogleFlightsMaxStops](/toolkits/search/reference#googleflightsmaxstops)), optional)_: Maximum number of stops (layovers) for the flight. Defaults to any number of stops.
- **`sort_by`** _(enum ([GoogleFlightsSortBy](/toolkits/search/reference#googleflightssortby)), optional)_: The sorting order of the results. Defaults to TOP_FLIGHTS.

<br />
<TabbedCodeBlock
tabs={[
{
label: "Call the tool directly",
content: {
Python: [
"/examples/integrations/toolkits/search/google_flights/search_roundtrip_flights_example_call_tool.py",
],
JavaScript: ["/examples/integrations/toolkits/search/google_flights/search_roundtrip_flights_example_call_tool.js"],
},
},
{
label: "Execute the tool with OpenAI",
content: {
Python: [
"/examples/integrations/toolkits/search/google_flights/search_roundtrip_flights_example_llm_oai.py",
],
JavaScript: ["/examples/integrations/toolkits/search/google_flights/search_roundtrip_flights_example_llm_oai.js"],
},
},
]}
/>

## SearchOneWayFlights

Retrieve flight search results for a one-way flight using Google Flights.

**Parameters**

- **`departure_airport_code`** _(string, required)_: The departure airport code. An uppercase 3-letter code.
- **`arrival_airport_code`** _(string, required)_: The arrival airport code. An uppercase 3-letter code.
- **`outbound_date`** _(string, required)_: Flight departure date in YYYY-MM-DD format.
- **`currency_code`** _(string, optional)_: Currency of the returned prices. Defaults to 'USD'.
- **`travel_class`** _(enum ([GoogleFlightsTravelClass](/toolkits/search/reference#googleflightstravelclass)), optional)_: Travel class of the flight. Defaults to 'ECONOMY'.
- **`num_adults`** _(int, optional)_: Number of adult passengers. Defaults to 1.
- **`num_children`** _(int, optional)_: Number of child passengers. Defaults to 0.
- **`max_stops`** _(enum ([GoogleFlightsMaxStops](/toolkits/search/reference#googleflightsmaxstops)), optional)_: Maximum number of stops (layovers) for the flight. Defaults to any number of stops.
- **`sort_by`** _(enum ([GoogleFlightsSortBy](/toolkits/search/reference#googleflightssortby)), optional)_: The sorting order of the results. Defaults to TOP_FLIGHTS.

<br />
<TabbedCodeBlock
tabs={[
{
label: "Call the tool directly",
content: {
Python: [
"/examples/integrations/toolkits/search/google_flights/search_one_way_flights_example_call_tool.py",
],
JavaScript: ["/examples/integrations/toolkits/search/google_flights/search_one_way_flights_example_call_tool.js"],
},
},
{
label: "Execute the tool with OpenAI",
content: {
Python: [
"/examples/integrations/toolkits/search/google_flights/search_one_way_flights_example_llm_oai.py",
],
JavaScript: ["/examples/integrations/toolkits/search/google_flights/search_one_way_flights_example_llm_oai.js"],
},
},
]}
/>

## Auth

The Arcade Google Flights toolkit uses the [SerpAPI](https://serpapi.com/) to search for flights from Google Flights.

- **Secret:**
- `SERP_API_KEY`: Your SerpAPI API key.

<Note>
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.
</Note>
92 changes: 92 additions & 0 deletions pages/toolkits/search/google_hotels.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# Google Hotels

import ToolInfo from "@/components/ToolInfo";
import Badges from "@/components/Badges";
import TabbedCodeBlock from "@/components/TabbedCodeBlock";
import TableOfContents from "@/components/TableOfContents";

<ToolInfo
description="Empower your agents to search for hotels using Arcade."
author="Arcade"
codeLink="https://github.com/ArcadeAI/arcade-ai/tree/main/toolkits/search"
authType="API Key"
versions={['0.1.0']}
/>

<Badges repo="arcadeai/search" />

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.

## Install

```bash
pip install arcade_search
```

<Note>
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.
</Note>

## Available Tools

<TableOfContents
headers={['Tool Name', 'Description']}
data={
[
['SearchHotels', "Retrieve hotel search results using the Google Hotels API."]
]
}
/>

## SearchHotels

Retrieve hotel search results using the Google Hotels API.

**Parameters**

- **`location`** _(string, required)_: Location to search for hotels, e.g., a city name, a state, etc.
- **`check_in_date`** _(string, required)_: Check-in date in YYYY-MM-DD format.
- **`check_out_date`** _(string, required)_: Check-out date in YYYY-MM-DD format.
- **`query`** _(string, optional)_: Anything that would be used in a regular Google Hotels search.
- **`currency`** _(string, optional)_: Currency code for prices. Defaults to 'USD'.
- **`min_price`** _(int, optional)_: Minimum price per night. Defaults to no minimum.
- **`max_price`** _(int, optional)_: Maximum price per night. Defaults to no maximum.
- **`num_adults`** _(int, optional)_: Number of adults per room. Defaults to 2.
- **`num_children`** _(int, optional)_: Number of children per room. Defaults to 0.
- **`sort_by`** _(enum ([GoogleHotelsSortBy](/toolkits/search/reference#googlehotelssortby)), optional)_: The sorting order of the results. Defaults to RELEVANCE.
- **`num_results`** _(int, optional)_: Maximum number of results to return. Defaults to 5. Max 20.

<br />
<TabbedCodeBlock
tabs={[
{
label: "Call the tool directly",
content: {
Python: [
"/examples/integrations/toolkits/search/google_hotels/search_hotels_example_call_tool.py",
],
JavaScript: ["/examples/integrations/toolkits/search/google_hotels/search_hotels_example_call_tool.js"],
},
},
{
label: "Execute the tool with OpenAI",
content: {
Python: [
"/examples/integrations/toolkits/search/google_hotels/search_hotels_example_llm_oai.py",
],
JavaScript: ["/examples/integrations/toolkits/search/google_hotels/search_hotels_example_llm_oai.js"],
},
},
]}
/>

## Auth

The Arcade Google Hotels toolkit uses the [SerpAPI](https://serpapi.com/) to search for hotels from Google Hotels.

- **Secret:**
- `SERP_API_KEY`: Your SerpAPI API key.

<Note>
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.
</Note>
Loading