Quick Start

This guide will get you all set up and ready to use the Castr GÜRŲ SDK. We'll cover how to get started using one of our SDK clients and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API.

There is NO signup required to start making requests to the Castr GÜRŲ Cloud — however, we recommend you register a Frame ID from your Cloud dashboard to access full features. You'll find it under Settings » API.

Setup Your (Tech) Stack

Before making your first API request, you need to pick which API client you will use. In addition to good ol' cURL HTTP requests, Castr GÜRŲ offers clients for JavaScript, Python, and Rust. In the following example, you can see how to install each client.

// Install or run the Castr GÜRŲ JavaScript/TypeScript CLI
npx castrguru@latest

Check out our list of first-party SDKs

Making a REST Request

After picking your preferred client, you are ready to make your first call to the Castr GÜRŲ Cloud. Below, you can see how to send a GET request to the Profile endpoint to get a list of all your users. In the cURL example, results are limited to ten users, the default page length for each client.

GET

/v1/profiles

curl -G https://castr.guru/v1/profiles \
  -H "Authorization: Bearer {token}" \
  -d limit=10

Making a GraphQL Query

IT IS HIGHLY RECOMMENDED TO USE GRAPHQL VS REST FOR PERFORMANCE REASONS

As an alternative to the traditional REST services, we highly recommend our efficient GraphQL server for your data needs.

WEBSOCKET

/graphql

{
  "hi": "there!"
}

Read the docs for the Conversations endpoint

Making a Backend Integration

GET