https://github.com/opencars/vin-decoder-api
:red_car: Decoding vehicle identification number
https://github.com/opencars/vin-decoder-api
restful-api vehicle vin-decoder
Last synced: 3 months ago
JSON representation
:red_car: Decoding vehicle identification number
- Host: GitHub
- URL: https://github.com/opencars/vin-decoder-api
- Owner: opencars
- License: mit
- Created: 2019-12-23T21:51:18.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-16T19:29:01.000Z (about 1 year ago)
- Last Synced: 2025-05-30T06:25:48.342Z (about 1 year ago)
- Topics: restful-api, vehicle, vin-decoder
- Language: Go
- Homepage: https://opencars.app
- Size: 87.9 KB
- Stars: 40
- Watchers: 3
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# VIN Decoder
> :red_car: Decoding vehicle identification number
## Development
Build the binary
```sh
make
```
Start postgres
```sh
docker-compose up -Vd
```
Run sql migrations
```sh
migrate -source file://migrations -database postgres://postgres:password@127.0.0.1:5432/vin-decoder\?sslmode=disable up
```
Run the web server
```sh
./bin/server
```
## Usage
For example, you get information about this amazing Tesla Model X
```sh
http http://localhost:8080/api/v1/vin-decoder/5YJXCCE40GF010543
```
```json
{
"vehicle": {
"check_digit": true,
"country": "United States",
"manufacturer": "Tesla, Inc.",
"region": "North America",
"serial": "010543",
"year": 2016
},
"vin": {
"vds": "XCCE40",
"vis": "GF010543",
"wmi": "5YJ"
}
}
```
## License
Project released under the terms of the MIT [license](./LICENSE).