-
Notifications
You must be signed in to change notification settings - Fork 28
Update README.md #6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,32 @@ | ||
| # <img src="solanabeach.svg" height="70px"> Solana Beach API | ||
|
|
||
| Hi, thanks for your interest in the Solana Beach API. | ||
| This API has provided users and developers with easy and free access to network data since the early days. | ||
| Please check whether this API matches your needs given the current rate limits: | ||
| - A general rate limit of 100 requests per 10 seconds. This limit applies to every request. | ||
| - An on-demand rate limit of 600 requests per 20 minutes. This limit applies to every request that triggers a call to an external data provider. | ||
|
|
||
| If you think we can serve your needs just ask any team member over [Telegram](https://t.me/+UW04VHylcMdlZmUy) or [Twitter](https://twitter.com/solanabeach_io) for a key and we will respond quickly. | ||
| ## Please request an API-Key | ||
| To receive an API key, please join our [Telegram Group](https://t.me/+UW04VHylcMdlZmUy) and send a DM to one of the team members. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sol |
||
|
|
||
| The two tables below show the rate limit restrictions and how you can trace and throttle your consumption. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Trust wallet |
||
|
|
||
| | Rate Limiter | Limit | Relevance | | ||
| | ----------- | ----- | ------- | | ||
| | Standard | 100 requests / 10 seconds | This rate limiter counts every request | | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Trust wallet |
||
| | On-Demand | 600 requests / 20 minutes | This rate limiter counts every request that<br> triggers a call to an external data provider | | ||
|
|
||
|
|
||
| | Response Header | Relevance | | ||
| | -------- | ------- | | ||
| | Solana-Beach-Standard-Credits-Remaining | You can use this value to throttle your scripts | | ||
| | Solana-Beach-Standard-Credits-Consumed | You can use this value to trace your consumption | | ||
| | Solana-Beach-On-Demand-Credits-Remaining | You can use this value to throttle your scripts | | ||
| | Solana-Beach-On-Demand-Credits-Consumed | You can use this value to trace your consumption | | ||
|
|
||
| ## Documentation | ||
| Our REST-API servers are available under the Base URL `https://api.solanabeach.io/v1`. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Trust wallet There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sol |
||
|
|
||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sol There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Trust wallet |
||
| Your requests must use the HTTP `GET` method and must include a `Accept: application/json` and `Authorization: YOUR-API-KEY` header. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Trust wallet There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
|
||
| Here are the [endpoints](https://app.swaggerhub.com/apis-docs/V2261/solanabeach-backend_api/0.0.1). | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Trust wallet |
||
|
|
||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Trust wallet |
||
| To dive into the API visit the [documentation](https://app.swaggerhub.com/apis-docs/V2261/solanabeach-backend_api/0.0.1). Important notice: Some endpoints are currently broken and we are working on repairing them. | ||
| __Important notice: Some endpoints are currently broken and we are working on repairing them.__ | ||
|
|
||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| If you like the API you can support maintenance and further development by delegating to the [Solana Beach Validator](https://solanabeach.io/validator/BeachiopjxQxL7CaHNSZsynApiZCKx9QFVtcWNz3jDBo). | ||
| ## We appreciate your delegation | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sol |
||
| If you're satisfied with this API, consider choosing the [Solana Beach Validator](https://solanabeach.io/validator/BeachiopjxQxL7CaHNSZsynApiZCKx9QFVtcWNz3jDBo) next time you are confronted with the decision where to delegate. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Trust wallet There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Trust wallet |
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.