Skip to content

Latest commit

 

History

History
50 lines (39 loc) · 7 KB

README.md

File metadata and controls

50 lines (39 loc) · 7 KB
description layout
Try Airstack API and integrate it into your dapp within minutes into your tech stack. You can either call the Airstack API with the Airstack SDKs or direct API call.
title description tableOfContents outline pagination
visible
true
visible
true
visible
true
visible
visible
true

🚀 Quickstart & SDKs

{% hint style="info" %}

  • API Endpoint: https://api.airstack.xyz/graphql
  • Record limit per API call
    • Maximum amount 200
    • Default to 50
    • We support cursor-based pagination to retrieve the next set of results.
  • It is best practice that you keep the size of the array for input filters, e.g. _in or _nin, to a maximum length of 200 per API call. {% endhint %}

To use the Airstack APIs, you have two options to make API calls:

Airstack SDKs

This is most suitable if you are using languages/frameworks that the SDKs support. Currently, Airstack offer 3 different SDKs:

SDKs Languages Description
Airstack Web SDK JS/TS frontend applications, including Vanilla.js, React.js, React Native, Next.js, etc.

This SDK is perfect for integrating Airstack APIs to any frontend JS/TS-based applications.

For React-based applications, there are available hooks for you to call the Airstack API and manage states easily.
Airstack Node SDK JS/TS Node.js backend applications.

This SDK is perfect for integrating Airstack APIs to any JS/TS Node.js-based backend/server-side applications, including Farcaster Frames.

This SDK might also work on serverless functions, e.g. Vercel Serverless Function.

Depending on the cloud runtime, some environment might have limitations that made it incompatible with the SDKs. In that case, you will need to call the API through Direct API call.
Airstack Python SDK Python-based applications. This SDK is perfect for integrating Airstack APIs to any Python-based applications/project, either for application development or data analysis.

We recommend that you use Airstack SDKs to integrate Airstack APIs easily to your application. Below are some tutorials to quickly get you started integrating Airstack depending on the tech stack you're using:

🌐 JavaScript (Browser)Learn how to integrate Airstack APIs to your frontend TypeScript/JavaScript application using the Airstack Web SDK.javascript-browser.md
⚛️ ReactLearn how to integrate Airstack APIs to your React-based application, including both React Web and React Native, using the Airstack Web SDK.react.md
⏭️ Next.js (Browser)Learn how to integrate Airstack APIs to your Next.js client-side (browser) application, using the Airstack Web SDK.
🗼 Node.jsLearn how to integrate Airstack APIs to your Node.js application using the Airstack Node SDK.node.md
🐍 PythonLearn how to integrate Airstack APIs to your Python-based application using the Airstack Python SDK.python.md

Others

Otherwise, you can always call the Airstack API directly with existing GraphQL library. For step-by-step guide on how to do that, check out the tutorial below:

🎯 Direct API CallLearn how to use Airstack by making direct API call without Airstack SDK. In this tutorial, you will learn how to integrate in Node.js. However, this should also work in any other tech stacks.direct-api-call.md