Skip to content
This repository was archived by the owner on Oct 11, 2024. It is now read-only.

Commit 18d35da

Browse files
authored
Merge pull request #431 from 0xProject/megan/update-api-docs
chore: Updated API docs for clarity
2 parents 0d0b60f + a2bda71 commit 18d35da

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

mdx/api/index.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ Unless the spec defines otherwise, errors to bad requests should respond with HT
7171
| 429 | Too many requests - Rate limit exceeded |
7272
| 500 | Internal Server Error |
7373
| 501 | Not Implemented |
74+
| 503 | Server Error - Too many open connections|
7475

7576
### Error reporting format
7677

@@ -204,7 +205,7 @@ Either a `sellAmount` or `buyAmount` is required.
204205
| `data` | The call data required to be sent to the `to` contract address. |
205206
| `value` | The amount of ether (in wei) that should be sent with the transaction. (Assuming protocolFee is paid in ether). |
206207
| `gasPrice` | The gas price (in wei) that should be used to send the transaction. The transaction needs to be sent with this `gasPrice` or lower for the transaction to be successful. |
207-
| `gas` | The estimated gas limit that should be used to send the transaction to guarantee settlement. A computed estimate is returned in all responses, for a more accurate estimate provide a `takerAddress` in the request. |
208+
| `gas` | The estimated gas limit that should be used to send the transaction to guarantee settlement. While a computed estimate is returned in all responses, an accurate estimate will only be returned if a `takerAddress` is included in the request. |
208209
| `estimatedGas` | The estimate for the amount of gas that will actually be used in the transaction. Always less than `gas`. |
209210
| `protocolFee` | The maximum amount of ether that will be paid towards the protocol fee (in wei), and what is used to compute the `value` field of the transaction. |
210211
| `minimumProtocolFee` | The minimum amount of ether that will be paid towards the protocol fee (in wei) during the transaction. |

0 commit comments

Comments
 (0)