API

Introduction

A consolidated API inclusive of all endpoints for protocols and tools within the Portal Network, it is an easy access to the Blockchain networks.

Authentication

Portal Network uses API keys to allow access to the API. Users can register a new Portal Network API key here (coming soon).

Portal Network expects for the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: auth_key

shell
python

Errors

This error section is stored in a separate file in includes/_errors.md. Slate allows you to optionally separate out your docs into many files...just save them to the includes folder and add them to the top of your index.md's frontmatter. Files are included in the order listed.

The Kittn API uses the following error codes:

Error Code

Meaning

400

Bad Request -- Your request is invalid.

401

Unauthorized -- Your API key is wrong.

403

Forbidden -- The kitten requested is hidden for administrators only.

404

Not Found -- The specified kitten could not be found.

405

Method Not Allowed -- You tried to access a kitten with an invalid method.

406

Not Acceptable -- You requested a format that isn't json.

410

Gone -- The kitten requested has been removed from our servers.

418

I'm a teapot.

429

Too Many Requests -- You're requesting too many kittens! Slow down!

500

Internal Server Error -- We had a problem with our server. Try again later.

503

Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

Last updated

Was this helpful?