Quick start
Get your API key and send your first Rye API request!
1. Grab your API Key
To make requests to the Rye GraphQL API, you will need to get an API access key by signing up on the Rye console. To do so:
- Navigate to, and log in to https://console.rye.com
- Under Access and Security, view and copy your API key

Access the API key from the Rye console
2. Initialize GQL client
Initialize a GQL client with your API key via the following recipe:
1️⃣
Initialize GQL client with your API Key
Open Recipe
3. Making your first GraphQL request
Rye uses GraphQL as the underlying technology to expose its API to developers. Read more about GraphQL here.
Here is an example of fetching an Amazon product from GraphQL. Make sure to replace your API key in the examples below.
3️⃣
Fetch product data from Rye inventory
Open Recipe
4. Explore the rest of the API
Explore the entire API offering live on the Rye Console. Take a glance through the remaining docs to figure out how the Rye API can integrate into your app!
Updated 4 days ago