Welcome to the {Un}pack API Documentation#
This documentation provides all the necessary information to integrate with our API. Within this documentation, you'll find detailed description of each component, how to get started, and best practices for using our API.Table of Contents#
Introduction#
At {Un}pack, our mission is simple: Trust! We aim to enhance the security and reliability of your blockchain interactions. Our mission is to enrich your blockchain journey by prioritizing safety and reliability.To simply put... Imagine you're playing in a big digital playground called the blockchain. We're here to make sure that no one can cheat or play unfairly. We watch over the playground, check all the rules, and keep everything safe so you can have fun without worrying.We bring an artillery of tools and expertise to analyze the network behind the scenes. Our services include:Reverse Engineering: We reverse engineer smart contracts (Solidity), blocks, and transactions from the Abstract Syntax Tree (AST) and bytecode (Opcode) level. We decode standards and analyze statements and instructions to understand network and actor behavior at any block.
Real-Time Forensics: We monitor new, archived, and pending transactions and blocks. Think of us as diligent detectives tirelessly collecting, sorting, and analyzing addresses and transactions. When necessary, we simulate networks to uncover any malicious actors.
Low-Cost APIs: Whether you're an experienced developer or new to coding, our APIs offer cost-effective *JSON-RPC, REST and *GraphQL endpoints.
Smart Widgets and Integrations: Our integration tools help you quickly implement our solutions in your Web3 applications, making them more trustworthy and resistant to spam and attacks. You can also build alerts to react in real-time.
Open Source: We are committed for the long run. Most of our work will be open-sourced on our official GitHub account.
We're just getting started! Our services are still under development, but we're working tirelessly behind the scenes to bring you something truly special. Stay tuned for exciting updates and new features! Meanwhile, play with our current limited version of the released API and let us know what you think!
JSON-RPC and GraphQL endpoints are still under development.Getting Started#
To start using the API, follow these steps:2.
Copy your Whitelisted API Key: Your key is automatically generated for you.
3.
Use API Key: When making requests, go to Auth, select Bearer Token from the dropdown, and paste your API key.
4.
Read the Documentation: Familiarize yourself with the API endpoints and request/response formats.
5.
Make a Test Call: Use our production environment to make your first API call.
Authentication#
You must include an API key in each request to the {Un}Pack API using the Authorization: Bearer {token} request header.Rate Limiting#
API access rate limits apply per API key on a time basis. The limit is 10 requests per minute. Depending on your plan, you may have usage limits. If you exceed either limit, your request will return an HTTP 429 Too Many Requests status code.If you need more than 10 requests per minute, please reach out to us on Discord.Each API response includes the following headers to help you monitor your usage:| Header | Description |
|---|
X-RateLimit-Limit | The maximum number of requests allowed per minute. |
X-RateLimit-Remaining | The number of requests remaining in the current rate limit window. |
X-RateLimit-Reset | The time when the current rate limit window resets in UTC epoch seconds. |
Support#
If you have any questions or need assistance, please reach out to our support team at info@unpack.dev or join our Discord Server to chat with us. We are here to help!Open Source#
We believe in the power of the open-source community. That's why most of our work is open-sourced and available for you to explore, contribute to, and use. Check out our repositories on our official GitHub account:
Thank you for choosing {Un}pack API. We look forward to seeing what you build with our platform!Modified at 2024-05-29 20:24:25
