Getting Started
Welcome to the Rarible API! This guide will walk you through the steps to get your API key and start building with the Rarible Protocol. Whether you're looking to experiment with our free plan or require the additional capabilities of our paid plans, we've got you covered.
Step 1: Get Started
Begin by visiting our website at www.rarible.org Once there, initiate your journey by clicking on the "GET STARTED" button. This action will guide you through the initial process of accessing our API.
Step 2: Choose Your Plan
Rarible offers a variety of plans to suit your needs, including a free Starter plan. Here are your options:
Free Plan: This plan is free and provides you with essential access to the Rarible Protocol API. It's perfect for individuals or teams just starting out and testing our API.
Paid Plans: For users requiring more bandwidth and additional perks. The paid optiosn includes VIP Support, SLAs, Premium access, and more. In addition, if none of the existing plans cover you needs, click on "Let's talk" to discuss a tailor-made offer for your needs.
You can compare the different plans by visiting our pricing overview at https://rarible.org/pricing.
Step 3: Sign In to the API Dashboard
Access the API Dashboard by signing in with an existing account or create a new one by connecting your wallet. Here’s how:
Creating a New Account:
- Connect Your Wallet: Choose your preferred wallet and connect it to the platform.
- Email Verification: Ensure to use an email address you have access to. After adding your email, you'll receive a verification code. Confirm your email by entering this code, and your account will be set up and ready to go.
Step 4: Payment Details (For Paid Plans)
If you've opted for a paid plan, navigate to the "Account & Billing" section to add your payment details. Our checkout process is integrated with Stripe, making it easy to manage subscriptions, view invoice history, and update billing information. If you're on the free plan, you can skip this step for now.
Step 5: Upgrade Your Plan (Optional)
Looking to upgrade? You can easily manage your plan and subscriptions in the Dashboard. Our Stripe-integrated checkout allows for a seamless transition and access to additional features.
Step 6: Create Your API Keys
To start building, you'll need to generate your API keys. Head over to the "API Keys" section in the dashboard and click on "Create Your API Keys". Here, you can specify the name of the key and add any allowed domains, especially if the key will be used in the frontend of your application. You will receive two keys, one for mainnet and one for testnet.
Step 7: Start Building
Congratulations! You're now ready to start building with the Rarible API.
Now, all you need to do is include the parameter **X-API-KEY**
in the Header of your request. Simple as that!
How to use the API keys with our SDK, please check here: https://github.com/rarible/sdk#api-querying
If you need any help or have questions, please feel free to always reach out directly to us via Discord Server
Updated 9 months ago