Skip to content

Commit b491f8a

Browse files
committed
Merge branch 'paperclip/SHA-1843'
docs(api-reference): add unknown_endpoint 410 error code + correct_endpoint field
2 parents d777954 + f5c7cf6 commit b491f8a

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

content/en/api-reference/overview.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,7 @@ All errors follow a consistent format:
208208
| `error.code` | Machine-readable error code |
209209
| `error.message` | Human-readable description |
210210
| `error.docs` | Link to relevant documentation (optional — included on auth, tier, rate limit, and streaming errors) |
211+
| `error.correct_endpoint` | The correct endpoint to use (optional — included on `unknown_endpoint` errors when the API recognizes the path as a known wrong route) |
211212
| `error.retry_after` | Seconds until retry is allowed (optional — included on `rate_limited` errors) |
212213

213214
## Standard Response Headers
@@ -313,5 +314,6 @@ All odds are returned as flat fields on each odds object:
313314
| `tier_restricted` | 403 | Endpoint not available on your tier |
314315
| `invalid_request` | 400 | Malformed request parameters |
315316
| `not_found` | 404 | Resource not found |
317+
| `unknown_endpoint` | 410 | Wrong API path — response includes `correct_endpoint` with the right route (e.g. `/api/v1/arbitrage``/api/v1/opportunities/arbitrage`) |
316318
| `upstream_error` | 502 | Temporary data fetch issue |
317319
| `internal_error` | 500 | Server error |

0 commit comments

Comments
 (0)