You'll find key usage notes below and API endpoints in the folders on the left nav beneath this doc. If you ever need help you can reach out to us.

Authentication, Rate Limits, and Error Handling

Authentication

Our service URL is https://api.us1.shinami.com/aptos/node/v1. You authenticate via an access key passed in a header ("X-Api-Key: ACCESS_KEY" or "Authorization: Bearer ACCESS_KEY"). These steps are done automatically by our TypeScript SDK. For more information, including how to set up API access keys, see our Authentication and API Keys guide. Region URLs - us1 above - only work with API keys created in the same region. So, to use this API, you'll make Node Service API keys in our US East - us1 region.

Rate Limits

When you surpass the QPS limit for a key, we return a HTTP 429. We recommend implementing retries with a backoff to handle any rate limits errors that arise. You can also adjust the rate limits of your keys to better balance your QPS allotment across your keys.

Error Handling

See our Error Reference guide.

How to Send a Request

When sending a request to our Node Service, make sure to do the following two things (done automatically by our TypeScript SDK).

1. Set the base URL to https://api.us1.shinami.com/aptos/node/v1
2. Send your access key in one of these two headers:
   1. "Authorization: Bearer YOUR_ACCESS_KEY"
   2. "X-Api-Key: YOUR_ACCESS_KEY"
3. Use an API key from the same region as the URL you're using. Region URLs - us1 above - only work with API keys created in the same region. So, to use this API, you'll make Node Service API keys in our US East - us1 region.
4. Use an access key tied to the network you want to interact with. When you create an API access key in your Shinami dashboard, you give it rights to exactly one network. We route to Mainnet or Testnet based on the API access key you send in the request.

Sample Request

Example Request Template

The TypeScript example uses the Shinami Clients SDK, which you can install with:

npm install @shinami/clients

Replace all instances of{{name}} with the actual value for that name

curl https://api.us1.shinami.com/aptos/node/v1/accounts/{{accountAddress}} \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {{aptosNodeServiceAccessKey}}"

import { createAptosClient } from "@shinami/clients/aptos";

const shinamiAptosClient = createAptosClient(SHINAMI_NODE_ACCESS_KEY);

const accountInfo = await shinamiAptosClient.getAccountInfo({ accountAddress: {{accountAddress}} });

Example Response

{
   "authentication_key" : "0x4d3e2cfa689883a76ea1600451e42691f1615153d4f44b89c92149afea3ceda3",
   "sequence_number" : "51"
}

{
   "authentication_key" : "0x4d3e2cfa689883a76ea1600451e42691f1615153d4f44b89c92149afea3ceda3",
   "sequence_number" : "51"
}

Another sample request

For another example that also shows you how to use the error metrics in your Shinami dashboard and our error guide, see our Guide to sending and debugging a Node Service request.

Methods

You can find the available methods on the lefthand navigation column of this page, just under this doc, beginning with methods for reading Account data.