urlscan.io logo urlscan.io
SecurityTrails logo

scalar.com Open in urlscan Pro
75.2.60.5  Public Scan

Back to summary
Submitted URL: http://scalar.com/
Effective URL: https://scalar.com/
Submission: On June 23 via api from US — Scanned from DE

Form analysis 1 forms found in the DOM

<form data-v-983db964="" data-v-9f6c0d8d="" data-v-adb00e96="" class="card-form">
  <div data-v-76a13854="" data-v-9f6c0d8d="" class="card-form-input"><label data-v-76a13854="" for="http.bearer.token"> Bearer Token </label><input data-v-76a13854="" placeholder="Token" id="http.bearer.token" autocomplete="off" data-1p-ignore=""
      spellcheck="false" type="password"><button data-v-76a13854=""
      class="scalar-icon-button grid aspect-square cursor-pointer rounded size-10 p-3 scalar-button-ghost bg-transparent text-c-3 transition-colors active:text-c-1 hocus:text-c-1 password-mask password-mask" type="button"><svg
        xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 12 12" class="scalar-icon size-full">
        <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M6 2.7C4 2.7 2 4 .7 5.5c-.3.3-.3.8 0 1.1C2 7.9 4 9.3 6 9.3s4-1.4 5.3-2.8c.3-.3.3-.8 0-1.1C10 4 8 2.7 6 2.7"></path>
        <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M7.8 6C7.8 7 7 7.8 6 7.8S4.2 7 4.2 6 5 4.2 6 4.2 7.8 5 7.8 6"></path>
      </svg><span class="sr-only">Show Password</span></button></div>
</form>

Text Content

Scalar

Register Login
Upload OpenAPI File

Menu
Home Guide Reference Changelog
Discord X (Formerly Twitter) GitHub



TESTING CLIENT FOR YOUR APIS


SCALAR BUILDS OPEN-SOURCE TOOLS, WITH FIRST CLASS OPENAPI SUPPORT.

1
CONNECT OPENAPI FILE

Once connecting your file our open sourced LLM will get to work automatically
generating your API Guide and Reference.


Click to Upload, or Drag & Drop
JSON, or YAML Files
File Uploaded Successfully
Upload New File
Your file is Uploading...
Please wait a moment
There was an Error Uploading File
Upload New File
Upload

No Open API file? Continue to step 2

2
THEME

Scalar is highly customizable, you have full access to our CSS variables so you
can rapidly overwrite our colors or fonts. Here are a few of our favourite
custom themes to get you started.

Default
Alternate
Purple
Solarized
Moon
Blue Planet
Deep Space
Saturn
Kepler-11e
Mars
3
GENERATED PAGES

Select what pages you'd like us to generate for you. Our API References are
fully open sourced and self hostable.


API References

API Guides

What would you like for us to prioritize adding in the future?

SDKs
Mock Server
API Workspace
API Testing Client
Changelog
Developer Portal
API Governance Hub
Status Page
Upload Your Swagger Spec to Continue
Preview & Edit Your Documentation
Generating Your API Guide...
Guide
Reference
Open Menu

Search⌃k


 * Resources

 * Toggle group  
   
   Markdown Support

 * Toggle group  
   
   Authentication
   
   * Create a user
     
       POST
   
   * Get a token
     
       POST
   
   * Get authenticated user
     
       GET

 * Toggle group  
   
   Planets

 * Toggle group  
   
   Webhook

 * Toggle group  
   
   Models

Dark Mode Powered by scalar.com

1.0.0
OAS 3.1.0


SCALAR GALAXY

Download OpenAPI Spec

The Scalar Galaxy is an example OpenAPI specification to test OpenAPI tools and
libraries. It’s a fictional universe with fictional planets and fictional data.
Get all the data for all planets.


RESOURCES

 * https://github.com/scalar/scalar
 * https://github.com/OAI/OpenAPI-Specification
 * https://scalar.com


MARKDOWN SUPPORT

All descriptions can contain tons of text Markdown. If GitHub supports the
syntax, chances are we’re supporting it, too.

Examples


BLOCKQUOTES

> I love OpenAPI. <3


TABLES

Feature Availability Markdown Support ✓


ACCORDION

<details>
  <summary>Using Details Tags</summary>
  <p>HTML Example</p>
</details>



IMAGES

Yes, there’s support for images, too!



Base URL
https://galaxy.scalar.com

Bearer Authentication (bearerAuth)NoneBearer Authentication (bearerAuth)Basic
Authentication (basicAuth)API Key (apiKeyHeader)API Key (apiKeyQuery)API Key
(apiKeyCookie)OAuth 2.0 Implicit (oauth2)
Bearer Token Show Password
Client Libraries

Shell

Ruby

Node.js

PHP

Python
Libcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpUnirestXMLHttpRequestAxiosfetchjQueryOkHttpundiciHTTPRequestAxiosFetchNSURLSessionCoHTTPcURLGuzzleHTTP
v1HTTP
v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession

More
cURL Shell


AUTHENTICATION # COPY LINK TO "AUTHENTICATION"

Some endpoints are public, but some require authentication. We provide all the
required endpoints to create an account and authorize yourself.

Endpoints

POST/user/signupPOST/auth/tokenGET/me


CREATE A USER # COPY LINK TO "CREATE A USER"

Time to create a user account, eh?

Body
application/json
Hide Child Attributes
name
required
string
email
required
string email
password
required
string
min: 
8
Responses
 * 201
   
   Created

 * 400
   
   Bad Request

POST/user/signup
Shell
cURLLibcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpUnirestXMLHttpRequestAxiosfetchjQueryOkHttpundiciHTTPRequestAxiosFetchNSURLSessionCoHTTPcURLGuzzleHTTP
v1HTTP
v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession

curl --request POST \
  --url https://galaxy.scalar.com/user/signup \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Marc",
  "email": "marc@scalar.com",
  "password": "i-love-scalar"
}'

Test Request
201400
Show Schema

{
  "id": 1,
  "name": "Marc",
  "email": "marc@scalar.com"
}

Created


GET A TOKEN # COPY LINK TO "GET A TOKEN"

Yeah, this is the boring security stuff. Just get your super secret token and
move on.

Body
application/json
Hide Child Attributes
email
required
string email
password
required
string
Responses
 * 201
   
   Token Created

POST/auth/token
Shell
cURLLibcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpUnirestXMLHttpRequestAxiosfetchjQueryOkHttpundiciHTTPRequestAxiosFetchNSURLSessionCoHTTPcURLGuzzleHTTP
v1HTTP
v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession

curl --request POST \
  --url https://galaxy.scalar.com/auth/token \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "marc@scalar.com",
  "password": "i-love-scalar"
}'

Test Request
201
Show Schema


Token Created


GET AUTHENTICATED USER # COPY LINK TO "GET AUTHENTICATED USER"

Find yourself they say. That’s what you can do here.

Responses
 * 200
   
   OK

 * 403
   
   Forbidden

GET/me
Shell
cURLLibcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpUnirestXMLHttpRequestAxiosfetchjQueryOkHttpundiciHTTPRequestAxiosFetchNSURLSessionCoHTTPcURLGuzzleHTTP
v1HTTP
v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession

curl --request GET \
  --url https://galaxy.scalar.com/me \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Test Request
200403
Show Schema

{
  "id": 1,
  "name": "Marc",
  "email": "marc@scalar.com"
}

OK


PLANETS # COPY LINK TO "PLANETS"

Everything about planets

Endpoints

GET/planetsPOST/planetsGET/planets/{planetId}PUT/planets/{planetId}DELETE/planets/{planetId}POST/planets/{planetId}/image
Show More


NEWPLANET # COPY LINK TO "NEWPLANET"

Payload
application/json

Information about a new planet

Hide Child Attributes
id
required
integer int64

Signed 64-bit integers (long type).

name
required
string
description
string | null
image
string | nullable
creator
object
Show Child Attributes
Responses
 * 200
   
   Return a 200 status to indicate that the data was received successfully


NEWUSER # COPY LINK TO "NEWUSER"

{} NewUser
name
required
string
email
required
string email
password
required
string
min: 
8


USER # COPY LINK TO "USER"

{} User
id
required
integer int64

Signed 64-bit integers (long type).

name
required
string
email
required
string email


CREDENTIALS # COPY LINK TO "CREDENTIALS"

{} Credentials
email
required
string email
password
required
string
Show More

Guide
Reference
Search
All-in-one Checkout
Transaction API
Link a Payment Processor
Three-Dimensional Secure
Set Up Webhooks
Sophisticated Metadata Association
Integrated Fraud Inspections
Creating a Basic ProjectCreate a User

When you're ready to create a user, you'll need to craft a POST http request.
You can do this using curl or your preferred SDK. The endpoint you'll be
targeting is https://api.users.com/v1/create. Once you've sent your request, the
server will respond. In this response, you'll find the UID of the user you just
created.

Add album to users playlist

If you're looking to add an album to a user's playlist, you need to have a few
things ready. First, you have to select an album and note its album ID. You also
need the user's ID and the playlist ID. Once you have these, you can send an
HTTP Post request to https://api.users.com/v1/playlist/add. Make sure to include
both the album ID and the user ID in your request. After your request has been
processed, you'll receive a response. This response will confirm the success of
your action and provide a link to the updated playlist.

Share playlist with team

After you've received the link to the playlist, you can easily share it with
your team. You'll do this by sending a POST HTTP request to the notify endpoint,
which is https://api.users.com/v1/notify/. In your request, you'll need to
include a couple of things. First, the unique teamID that identifies your team.
Second, you'll add a string message. This is the message you want to notify your
team members with. Once you've done all this, your team members will be
notified!

Delete Team Members

If you're looking to remove team members, you'll first need to gather the IDs of
the team members you want to delete. Once you have those, you're going to send a
DELETE HTTP request. This request should be sent to
https://api.users.com/v1/team/delete. After your request has been processed,
you'll get a response. This response will contain a list of the team members'
IDs that are still on the team. This way, you'll be able to confirm that the
members you wanted to remove are no longer on the team.

On this Page
Create a User
Add album to users playlist
Share playlist with team
Delete Team Members



SCALAR IN USE


Fly.io
docs.machines.dev

Acctual
docs.acctual.com

Kick
Private Docs

Gitbook
"Test it" Powered by Scalar

Langchain
Scalar Docusaurus Integration

Jan
Scalar Docusaurus Integration


PRICING: SCALARS FREE PLAN INCLUDES HOSTING ON OUR SUBDOMAIN
*.APIDOCUMENTATION.COM. OUR PAID PLAN WHICH ALLOWS YOU TO PUBLISH ON YOUR OWN
SUBDOMAIN COSTS $12 PER USER/MONTH. NEED SOMETHING CUSTOM?

TRY IT OUT OR EMAIL MARC

 * API Documentation
 * Swagger Editor

 * Support
 * Changelog
 * Terms & Conditions
 * Privacy Policy

 * X (Formerly Twitter)
 * GitHub