Overview
Direct API is an evolution of the existing passthrough V1 endpoint offered in the Unified API, which provides a way for users to call any endpoint in a list of supported providers. Direct API expands on this concept while offering better usability to make the transition to Uniblock as seamless as possible.
The Direct API differs from our flagship Unified API in the following ways:
- Authentication: The same authentication method for the first-party endpoint can be used to call the same endpoint using Direct API, whether this is through a header, URL, or anything else. If no authentication is passed in, Direct API will attempt to retrieve the authentication information stored in the project associated with the Uniblock API key for the requested provider. Anything passed in directly to the header, URL, etc. will take priority.
- Lightweight: The results are returned exactly as they would be if the first-party endpoint was called. The normalization process is bypassed when calling through Direct API, a process that happens with the Unified API to deliver consistent responses from the various providers.
- Provider: The only provider that is called through Direct API is the one specified when calling Direct API (more details on this below).
All other features that are present in Unified API are also present in Direct API, including (but not limited to) Autorouting, API Request Logs, and Unified Billing.
Getting Started
Direct API follows the same structure for all providers that are supported by this endpoint: https://api.uniblock.dev/direct/{provider}/{prefix}/path/to/endpoint
{provider}
: Replace this with the name of the provider to use with Direct API. The list of supported providers is listed below and as subpages under the Direct API section.{prefix}
: (Optional) Some providers require the user to specify a prefix in the base URL, such as the network. This can be left out for providers that do not have this requirement, and additional information regarding what the prefix might be for each provider is detailed in their respective pages.- Header -
x-api-key
: As with the Unified API, a project's API key is required to use Direct API.
As for everything else, including the query, other header properties, and the body, The same values and data can be used as if the provider's API endpoints were being called directly.
Updated 4 months ago