Getting Started

Welcome to M3O! Follow this guide to get started.

Sign Up

Sign up or log in to M3O so you can get a token. You can use password based log in or oauth.

Note: For security purposes, if you log in with oauth, the password is no longer valid unless you reset it.

Try out Hello world!

Here's a simple example to call the helloworld API:

Hello World example

Discover APIs

Browse all of our APIs on the Explore page.

Generate an API token

To create a new access token, visit Tokens page. You can specify which APIs the token can call or leave scopes blank to create a token that has access to all the APIs.

Using an API

M3O APIs can be accessed via the url https://api.m3o.com/v1/*.

All API calls require an API token to be provided. You can specify the token in one of three ways:

  • via the "Authorization" header. Prepend your API token with the string "Bearer" i.e. the header will look like "Authorization: Bearer <YOUR API TOKEN>"
  • via HTTP basic authentication. Use the string "user" as the username and use your API token as the password
  • via the "Sec-Websocket-Protocol" header for websocket calls. Pass your API token as the protocol name

APIs provide a JSON based request/response and also a `Content-Type: application/json` header for each request.

Download the CLI

M3O includes a command line interface from which you can explore and query services. Go to GitHub to download the latest release binary.

Account Billing

Each account has a credit based balance. Any request made to a an API will be debited from the balance in real time. When your balance is zero requests to APIs will return a blocked status.

API calls are charged at 0.000001 credit per request (£1 per credit). Premium APIs are charged differently. See the pricing page for more info.

To check your balance and top-up your account head to the Billing page.

Fair Usage Policy

Our free tier is rate limited to 10 requests per second. This can be unlocked by upgrading to the Pro subscription. We also invoke fair usage limits on compute and storage. During the beta period no hard limits are enforced, we will reach out if there are any issues.

Feedback or Support

Join the community and ask questions on Discord. If you're subscribed to the Pro tier email [email protected] for help. Otherwise you can provide feedback at [email protected].