Overview of MultiversX Gateway REST API
The MultiversX's Gateway REST API can be used by any application - dApp, desktop or server application - to interact with the Blockchain.
The Gateway is backed by the proxy and the names Gateway or Proxy are often referred as the same thing.
The difference is that
gateway is MultiversX's infrastructure backed by the mx-chain-proxy-go repository.
Proxy API vs. Observer API
Both the MultiversX Proxy and the Node (Observer) are designed to expose (almost) the same HTTP endpoints, though this doesn't always hold due to architectural constraints. When describing each HTTP endpoint on the following pages, if there is any discrepancy or mismatch between the Proxy endpoint and the Observer endpoint, this will be captured in a note as the one below:
Proxy/Gateway endpoints are referred as
https://gateway.multiversx.com/...., while node endpoints are referred as
Currently, authentication is not needed to access the API.
HTTP Response format
Each request against the MultiversX API will resolve to a JSON response having the following structure:
That is, all responses will contain the fields
In case of a success, the
data field is populated, the
error field is empty, while the
code field is set to
**successful**. For example:
In the case of an error, the
data field is unset, the
error field contains a human-readable description of the issue, while the
code field is set to a both machine and human-readable error code. For example:
"error": "checksum failed. Expected 2rq9g5, got smsgld.",
When describing each HTTP endpoint on the following pages, the basic structure of the response is simplified for brevity, and, in general, only the actual payload of the response is depicted.