Skip to main content

Quickstart Guide

We're excited to have you try out Estuary! Estuary is a reliable way to upload public data onto Filecoin and pin it to IPFS.

For more information on what Estuary is, visit our home page. If you are a developer looking to use Estuary, continue through this quickstart guide.

Questions? Visit the FAQ or reach out to us on Slack!

Get an API key

As a developer you have probably used API keys before. Estuary provides a unique identifier used to authenticate a user, developer, or calling program to an application programming interface we have created.

If you don't know what an API key is, this tutorial will be challenging for you, but you can reach out to us if you're stuck. API keys are the standard way to authenticate a project with an API rather than a human user. It is also important you understand how to protect your API key/secrets from bad actors and abuse. If this concept is foreign to you, you might be better off just using https://estuary.tech and storing data through our website.

Getting started​

Before we start, make sure you have done the following:

  • Create an account on https://estuary.tech. If you have not done this, you won't be able to get an API key for yourself. To create an account you can request access here.

  • Setup an example application. To use the API in a meaningful way, you should setup a sample application. You can use our next-sass (React + NextJS) GitHub template, our origin (Vue + Vite) template, or anything of your own choosing.

  • Have experience running code on your machine. You're going to have a really hard time with this tutorial if you've never run code on your computer.

If you're ready, let's begin!

Sign in to Estuary​

When you sign in to Estuary, you should should land on this page.

https://next-s3-public.s3-us-west-2.amazonaws.com/estuary-marketing-hero.png

Click on API keys.

Generate an API key​

On this screen you should see a button to generate an API key, click it.

https://next-s3-public.s3-us-west-2.amazonaws.com/estuary-marketing-hero.png

Test your API key​

Use your new API key on the screen to the right by clicking the Authorize button and pasting in your Api Key.

HOWEVER please note that the Authorize button sets the HTTP Authorization Header and to properly use the Estuary API you should enter a value for the header in the format Bearer ESTxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxARY

What is next?​

Now you are ready for the next part, uploading your first file.