Base URL: /, Version: 1.0.0
An overhide "remuneration provider" API for Ethereum networks.
These API docs are live: connected to the rinkeby Ethereum network.
These APIs are available on two networks:
GitHub repository for this overhide-ethereum service: https://github.com/overhide/overhide-ethereum
Motivation for this API is written up at https://overhide.io/2019/03/20/why.html.
An example show case leveraging this API is at https://github.com/overhide/ledgers.js.
| Path | Operation | Description |
|---|---|---|
| /get-transactions/{from-address}/{to-address} | GET |
Retrieve remuneration transactions and/or their tally. |
| /is-signature-valid | POST |
Check signature. |
Retrieve the latest remuneration transactions (and/or their tally) from from-address to to-address
| from-address | A public address from which to verify payment details (amount/date) to the to-address. A 42 character 'hex' string prefixed with '0x'. |
path | string | |
| to-address | The target public address to check for payment made. A 42 character 'hex' string prefixed with '0x'. |
path | string | |
| max-most-recent | Number of most recent transactions to retrieve. |
query | integer | |
| since | Retrieve transactions since this date-time (inclusive) until now. The date-time is a string in ISO 8601/RFC3339 format. |
query | string | |
| tally-only | If present and set to If not present or set to anything but |
query | boolean |
application/json
List of transactions and/or tally.
Tally of all the transactions from from-address to to-address in the range required (since,max-most-recent,or unlimited).
All the transactions from from-address to to-address in the range required (since,max-most-recent,or unlimited).
A bad request from the client results in one or more of the following error message strings.
The message enum might be extended by remuneration provider.
Authentication information is missing or invalid
| WWW_Authenticate | string |
Client is calling the API too frequently.
Conditions for this response to occur are remuneration provider dependant.
Check if provided signature corresponds to the provided address, resolved to the provided message.
Check if provided address is a valid address with at least one entry on the ledger.
application/json
base64 encoded string of signature to verify
base64 encoded string of message that's signed for the address
the address (public key) of signature: a 42 character 'hex' string prefixed with '0x'
application/json
Signature is valid.
A bad request from the client results in one or more of the following error message strings.
The message enum might be extended by remuneration provider.
Authentication information is missing or invalid
| WWW_Authenticate | string |
Client is calling the API too frequently.
Conditions for this response to occur are remuneration provider dependant.
A bad request from the client results in one or more of the following error message strings.
The message enum might be extended by remuneration provider.
Authentication information is missing or invalid
| WWW_Authenticate | string |
Client is calling the API too frequently.
Conditions for this response to occur are remuneration provider dependant.
Value of the transaction.
Date-time timestamp of the transaction.
The date-time is a string in ISO 8601/RFC3339 format.