NAV Navbar
shell python

Introduction

Welcome to the Portal Network API documentation! Portal Network provide you an easy access to any Blockchain networks (Bitcoin, Ethereum, and more coming soon). You can use our API to access Portal Network API endpoints. The documentation is currently a Work In Progress.

Authentication

To authorize, use this code:

import portalnetwork

api = portalnetwork.authorize('auth_key')
# With shell, you can just pass the correct header with each request
curl "api_endpoint_here"
  -H "Authorization: auth_key"

Make sure to replace auth_key with your API key.

Portal Network uses API keys to allow access to the API. You can register a new Portal Network API key here (link comiong 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

Errors

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.