> For the complete documentation index, see [llms.txt](https://devhub.autograb.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://devhub.autograb.com/nz-autograb-api-doc/autograb-basics/api-test-cases.md).

# API Test Cases

Test your requests in a safe zero-cost way through our test case set.

You can use our test cases to confirm your implementation on our production endpoints. Requests using these values are not billable: sandbox responses carry `sandbox: true` and `billable: false`, and never reach an upstream data provider.

## Test Cases

The test cases are all linked. In New Zealand, plate lookups resolve to the fake 2022 MG HS (vehicle ID `3333333333333333`, VIN `00000000000000002`). The Australian values (vehicle ID `1111111111111111`, VIN `00000000000000000`, a fake 2019 Toyota Corolla) and the EV values (vehicle ID `1111111111111112`, VIN `00000000000000010`, a fake 2023 Tesla Model Y) are accepted here as well, so one integration test suite can run against any regional endpoint.

Plates are matched case-insensitively and ignore spaces and hyphens.

### Universal values

These work in every AutoGrab region.

| Type               | Value               | Outcome                                                                                                             |
| ------------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------- |
| Registration Plate | `REG4SUCCESS`       | Returns a successful lookup response with a high-quality vehicle match for an ICE vehicle                           |
| Registration Plate | `REG4SUCCESSEV`     | Returns a successful lookup response with a high-quality match for an EV                                            |
| Registration Plate | `REG4WARNING`       | Returns a successful lookup response with a low-match quality warning                                               |
| Registration Plate | `REG4NOMATCH`       | Returns the VIN and vehicle description but no matching vehicle                                                     |
| Registration Plate | `REG4VINONLY`       | Only returns the VIN and no other vehicle details                                                                   |
| VIN                | `00000000000000002` | Returns a valid VIN match in New Zealand                                                                            |
| VIN                | `00000000000000000` | Returns a valid VIN match for an ICE vehicle (Australian fixture)                                                   |
| VIN                | `00000000000000010` | Returns a valid VIN match for an EV                                                                                 |
| Vehicle ID         | `3333333333333333`  | Can be used for /predict, /predict/conditions, /residual or /sourcing. Returns the same fixed prediction every time |
| Vehicle ID         | `1111111111111111`  | Australian fixture, for the same endpoints                                                                          |
| Vehicle ID         | `1111111111111112`  | The EV vehicle ID, for the same endpoints                                                                           |

### New Zealand plates

A set in the NZ plate format for tests that validate plate shape before calling us. The `ZZZ` block of the LLLNNN series is decades from being issued, so no real vehicle can ever collide with these.

| Value    | Outcome                                                                                   |
| -------- | ----------------------------------------------------------------------------------------- |
| `ZZZ111` | Returns a successful lookup response with a high-quality vehicle match for an ICE vehicle |
| `ZZZ222` | Returns a successful lookup response with a high-quality match for an EV                  |
| `ZZZ333` | Returns a successful lookup response with a low-match quality warning                     |
| `ZZZ444` | Returns the VIN and vehicle description but no matching vehicle                           |
| `ZZZ555` | Only returns the VIN and no other vehicle details                                         |

## Supported Endpoints

Test cases are supported across a range of API endpoints listed below. If the endpoint you are testing with is not listed get in touch to request test data.

* `/valuations/predict`
* `/valuations/vins`
* `/valuations/registrations`
* `/valuations/residual`
* `/valuations/predict/conditions`
* `/sourcing/market_overlay`
* `/sourcing/market_overlay/statistics`

## Implementation Guide

An example implementation could run a test as part of an integration test or development process. For example, you could test a valuation flow by first using a registration plate to get the ID (which is also test data) and send that to a /predict to get a valuation and a market overlay.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://devhub.autograb.com/nz-autograb-api-doc/autograb-basics/api-test-cases.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
