api – PullMonkey Blog

VIN API – Do you know about the complete data set?

Sat, 04 Aug 2012 15:42:04 +0000

Looking at our data trends for VIN API, we show about 15% of all requests are for the complete data set. It's the same price as the basic data set and rich with a ton of data.

Check out the data set from this post over 1 and half years ago. On top of the basic data set's year, make and model, the complete data set comes with data like MSRP, MPG (city and highway), dealer invoice, gas tank size, etc.

We get tons of hits for basic data, but at no additional charge we also provide the complete data set. Just add a complete
=> "true" to your request. So simple and there's no performance hit.

For more information, check out or examples and faq.

Enjoy!

Here's another look at the data elements from a comprehensive query:



	Std.
	N/A
	36,000 mile
	Std.
	N/A
	Coil
	N/A
	No data lbs
	N/A
	Std.
	Disc
	Disc
	187.60 in.
	N/A
	N/A
	N/A
	Std.
	Std.
	Std.
	N/A
	Opt.
	1000 lbs
	$25,900 USD
	N/A
	36 month
	Std.
	N/A
	Std.
	N/A
	21 miles/gallon
	N/A
	43.10 in.
	N/A
	30 miles/gallon
	N/A
	Std.
	105.10 in.
	N/A
	N/A
	Coil
	FWD
	Opt.
	N/A
	61.20 in.
	N/A
	No data lbs
	4-Wheel ABS
	Std.
	2003
	No data lbs
	Std.
	N/A
	Std.
	Std.
	5
	N/A
	Opt.
	Std.
	N/A
	Std.
	5-Speed Automatic Overdrive
	No data in.
	30 miles/gallon
	Std.
	$23,305 USD
	N/A
	88.00 cu.ft.
	3.0L V6 SOHC 24V
	55.40 in.
	N/A
	36 month
	Std.
	Std.
	17.10 gallon
	N/A
	N/A
	36,000 mile
	No data
	Taffeta White
	37.50 in.
	No data USD
	Opt.
	Std.
	Ivory Leather Interior
	Opt.
	N/A
	N/A
	Ind
	N/A
	Std.
	55.70 in.
	Std.
	61.10 in.
	2003
	Opt.
	N/A
	No data in.
	N/A
	Accord
	N/A
	N/A
	54.20 in.
	N/A
	Std.
	N/A
	Std.
	N/A
	Opt.
	N/A
	N/A
	N/A
	60 month
	Std.
	46.10 in.
	12.80 cu.ft.
	N/A
	N/A
	N/A
	N/A
	No data in.
	Ind
	N/A
	N/A
	N/A
	36.10 in.
	Std.
	N/A
	Std.
	No data lbs
	71.30 in.
	Std.
	35.40 in.
	COUPE 2-DR
	56.10 in.
	N/A
	Honda
	Std.
	N/A
	No data in.
	N/A
	UNITED STATES
	205/60R16
	Std.
	Std.
	N/A
	Std.
	Opt.
	1000 lbs
	Std.
	No data lbs
	N/A
	EX V6 coupe AT
	31.90 in.
	Std.
	R&P
	No data in.
	21 miles/gallon
	Std.
	Unlimited mile
	Std.
	N/A
	Std.
	N/A
	N/A
	Std.
	Std.
	N/A

view raw gistfile1.xml hosted with ❤ by GitHub

]]>

Headers and Footers in ruby’s Spreadsheet gem

Thu, 26 Apr 2012 19:17:20 +0000

Have you ever needed to add a header or footer to your spreadsheets in ruby?
Yah, well, we have
Yes, you can do this with the Write Excel gem.
But we've already written years worth of spreadsheet code with the spreadsheet gem and don't want to rewrite it all.

Anyway, we thought we'd share our little trick to get page headers using the spreadsheet gem.

	module Spreadsheet
	module Excel
	module Writer
	class Worksheet
	alias_method :write_from_scratch_without_header, :write_from_scratch
	def write_header
	write_op opcode(:header), [@worksheet.header.bytesize, 0].pack("vC"), @worksheet.header
	end
	def write_from_scratch
	write_header
	write_from_scratch_without_header
	end
	end
	end
	end
	class Worksheet
	attr_accessor :header
	def add_header(str)
	@header = str
	end
	end
	end

view raw gistfile1.rb hosted with ❤ by GitHub

So what you see here (above) goes into a config/initializer, something like RAILS_ROOT/config/initializer/enable_headers_in_spreadsheet_gem.rb. Here's what's going on:

1) We know that the write_from_scratch method is called when everything is said and done and the data is ready to be written to the spreadsheet file. So we make use of this and alias that method to write_from_scratch_without_header. Which opens us up to call our write_header method inside our write_from_scratch method which, of course, will call the original write_from_scratch method.

2) Our write_header method makes use of the already existing opcode for Header in the spreadsheet gem. It's not being used, so my guess is the developers intend on solving this issue at some point. We have to send the opcode, the length info and the string we want to write out. This was the trickiest part to figure out.

3) We expose an add_header method that simply takes a string and stores it in the header accessor. This means, to set the header, you simply say sheet.add_header("foo header").

To implement the footer, you'd just do the same thing, create a footer accessor, add a method to update it. Then build the writer_footer method with opcode(:footer) and append write_footer at the end of write_from_scratch.

Well, that took us some time to figure out, so enjoy and let me know if you have any questions.

]]>

VIN API – fair pricing model

Mon, 24 Jan 2011 22:02:39 +0000

It can't be a shock to any of you that after many months (wait - more like a full year) of running VIN API completely free and out-of-pocket, it is time to monetize. As I am sure most of you know, the back-end data is quite pricey. For example, a monthly subscription for a "lite" data set (your typical year, make, model, engine type, etc) at one of the better known distributors would run you about $260.00 a month for ~800 VIN decodings. This is some very expensive data at 32.5 cents a VIN. Some of you that use our API are running 50,000+ VINs through in a weekend, that is $16,000! Wow!

Ok, so what did we decide to do? Well first, and most importantly, we decided to keep the service up and running; for a while there it was looking pretty bleak and if you take a second to look at the numbers (financially) you can understand why. Anyway, to be as fair as possible, we did not feel this could be monetized as a subscription-based product, some months you need 500,000 VINs and some only a 1,000. Looking at the data for year, we had many questions - what plan would you pick? should the plan rollover it's unused decodings?

We discovered a lot of complexity in the subscription model, so we decided to setup the pay as you go plan, where you buy your decodings at various bulk levels. For instance, you could buy in groups of 1,000 or 10,000 or 100,000 such that you would realize savings on a price-per-VIN basis the larger the group you purchase. There is no use policy either, so you can sit on the VINs for as long as you want, or you can even buy decodings the day (even the minute) before you need them. No monthly credit card bill, no rollovers, just simple "buy what you need," and if you buy in bulk, you save.

Another consideration in doing this was having to maintain soft limits. For example, if the user purchases the 5,000 VINs per month plan, and the their site does well this month and they need 6000 VINs, should they have chosen the 10,000 VIN plan? We didn't think so, we figured no hard limit, just soft limits, and after the soft limit is hit, we would charge the additional VINs at the current rate per VIN to the user's next month's bill. We tried to explain this to a few current users that are helping us come up with reasonable rates and they were not all that thrilled about it. So we had a problem, we did not want users to pay for what they did not need, but at the same time we did not want to cut users off in the middle of a month when they hit their limit. That entire idea had to be scrapped and along with it went the idea behind the subscription plan itself. We like it though, it's simple now - buy your decodings and use your decodings, we will email you if you are getting low and may want to add decodings to your account.

Subscription models are great for static resources and static services, but not a single one of our customers decodes the same number of VINs each month, so it just won't work. So onward and upward, pay as you go and regardless of how the other API providers offer their service, we are excited to be a little different and lot cheaper as you will soon find out.

Enjoy!

]]>

VIN API – PHP and XML Parsing

Mon, 17 Jan 2011 21:58:46 +0000

Thanks go to Michael for sharing his hard work with the rest of you VIN API and PHP developers
I hope this helps -


	// VIN API decoder for PHP 4.x+

	define('ELEMENT_CONTENT_ONLY', true);
	define('ELEMENT_PRESERVE_TAGS', false);

	function getXML($vin) {
	$curl = curl_init();
	curl_setopt ($curl, CURLOPT_URL, 'http://vinapi.skizmo.com/vins/'. $vin.'.xml');
	curl_setopt ($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/xml', 'X-VinApiKey: #YOURAPIKEYGOESHERE#')); //use your API key here
	curl_setopt ($curl, CURLOPT_RETURNTRANSFER, true);
	$result = curl_exec ($curl);
	curl_close ($curl);
	return $result;
	}

	function parseVIN($VIN) {
	$info = array("model", "body-style", "country", "world-region", "vin", "engine-type", "transmission", "year", "make"); //include all values you want decoded

	$info = sort($info); //alphabetical order

	foreach ($info AS $type) {
	$vin[$type] = parseDATA($type, $VIN);
	}
	return $vin;
	}

	function parseDATA($element_name, $xml, $content_only = true) {
	if ($xml == false) {
	return false;
	}
	$found = preg_match('#<'.$element_name.'(?:\s+[^>]+)?>(.*?)'.
	'#s', $xml, $matches);
	if ($found != false) {
	if ($content_only) {
	return $matches[1]; //ignore the enclosing tags
	} else {
	return $matches[0]; //return the full pattern match
	}
	}
	// No match found: return false.
	return false;
	}

	// Parse passed VIN to remove illegal characters
	$vin = preg_replace("/[^A-Za-z0-9.]/", "", $_GET['vin']);

	if(isset($_GET['vin'])) {
	$data = getXML($vin);
	$data = parseVIN($data);
	if ($data != false) {
	foreach ($data AS $key => $value) {
	echo ucfirst($key) . ": " . $value . " ";
	} // outputs each XML node available
	} else {
	echo "VIN did not return any data.";
	}
	}

	?>

view raw gistfile1.php hosted with ❤ by GitHub

]]>

VIN API Examples for PHP and VB .NET

Thu, 13 Jan 2011 23:03:40 +0000

A few of our VIN API customers have been kind enough to take our Ruby and curl examples and come up with .NET and PHP implementations.
Here is a VB .NET example:

	Public Function DecodeVIN(ByVal VIN As String, Optional ByVal Complete As Boolean = False) As String
	Try
	Dim aResponse() As Byte
	Dim sResponse As String = ""
	Dim oWebclient As New WebClient
	Dim oEncoder As New System.Text.ASCIIEncoding

	'Call the API
	oWebclient = New WebClient
	oWebclient.Headers.Add("X-VinApiKey", "APIKEYGOESHERE")

	If Complete = True Then
	aResponse = oWebclient.DownloadData("http://vinapi.skizmo.com/vins/" & VIN & ".xml?complete=true")
	Else
	aResponse = oWebclient.DownloadData("http://vinapi.skizmo.com/vins/" & VIN & ".xml")
	End If
	sResponse = oEncoder.GetString(aResponse)
	'Debug.Print(sResponse)

	Return sResponse
	Catch ex As Exception
	End Try
	Return Nothing
	End Function

view raw gistfile1.bas hosted with ❤ by GitHub

And for PHP, you have this:


	function decodeVIN($vin){
	$curl = curl_init();
	curl_setopt ($curl, CURLOPT_RETURNTRANSFER, 1);
	curl_setopt ($curl, CURLOPT_URL, 'http://vinapi.skizmo.com/vins/'.$vin.'.xml');
	curl_setopt ($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/xml', 'X-VinApiKey: YOUR_API_KEY_GOES_HERE'));
	$result = curl_exec ($curl);
	curl_close ($curl);
	return $result;
	}
	$vin = preg_replace("/[^A-Za-z0-9.]/", "", $_GET['vin']);
	if(isset($_GET['vin'])){
	$decoded_vin = decodeVIN($vin);
	echo $decoded_vin;
	}
	?>

view raw vinapi.php hosted with ❤ by GitHub

Hope this helps and if you have examples for other programming languages, please let us know.

]]>

Vin API – Phase II

Thu, 13 Jan 2011 22:42:14 +0000

We've just finished adding A LOT more details to VIN API's result set. This time we've added things like MPG, MSRP, cargo room/volumn, etc. See the full list below, it is very comprehensive.

If you use ruby (look for a future post with .NET and PHP examples), and want the complete dataset, you would setup your ActiveResource like this:

	class VinApi < ActiveResource::Base
	headers["X-VinApiKey"] = "YOUR_API_KEY_GOES_HERE"
	self.site = "http://vinapi.skizmo.com"
	self.element_name = "vin"
	end

view raw gistfile1.rb hosted with ❤ by GitHub

And then call our API like this:

VinApi.find('1HGCM82633A004352', :params => {:complete => "true"})

view raw gistfile1.rb hosted with ❤ by GitHub

The only change (for those of you who have already implemented phase I) is to send in a "complete" parameter with value of "true" ... upon doing so, VIN API will send you the complete dataset versus the basic (and default) dataset.

The results would look like this (in XML) and be prepared because it is lengthy:



	Std.
	N/A
	36,000 mile
	Std.
	N/A
	Coil
	N/A
	No data lbs
	N/A
	Std.
	Disc
	Disc
	187.60 in.
	N/A
	N/A
	N/A
	Std.
	Std.
	Std.
	N/A
	Opt.
	1000 lbs
	$25,900 USD
	N/A
	36 month
	Std.
	N/A
	Std.
	N/A
	21 miles/gallon
	N/A
	43.10 in.
	N/A
	30 miles/gallon
	N/A
	Std.
	105.10 in.
	N/A
	N/A
	Coil
	FWD
	Opt.
	N/A
	61.20 in.
	N/A
	No data lbs
	4-Wheel ABS
	Std.
	2003
	No data lbs
	Std.
	N/A
	Std.
	Std.
	5
	N/A
	Opt.
	Std.
	N/A
	Std.
	5-Speed Automatic Overdrive
	No data in.
	30 miles/gallon
	Std.
	$23,305 USD
	N/A
	88.00 cu.ft.
	3.0L V6 SOHC 24V
	55.40 in.
	N/A
	36 month
	Std.
	Std.
	17.10 gallon
	N/A
	N/A
	36,000 mile
	No data
	Taffeta White
	37.50 in.
	No data USD
	Opt.
	Std.
	Ivory Leather Interior
	Opt.
	N/A
	N/A
	Ind
	N/A
	Std.
	55.70 in.
	Std.
	61.10 in.
	2003
	Opt.
	N/A
	No data in.
	N/A
	Accord
	N/A
	N/A
	54.20 in.
	N/A
	Std.
	N/A
	Std.
	N/A
	Opt.
	N/A
	N/A
	N/A
	60 month
	Std.
	46.10 in.
	12.80 cu.ft.
	N/A
	N/A
	N/A
	N/A
	No data in.
	Ind
	N/A
	N/A
	N/A
	36.10 in.
	Std.
	N/A
	Std.
	No data lbs
	71.30 in.
	Std.
	35.40 in.
	COUPE 2-DR
	56.10 in.
	N/A
	Honda
	Std.
	N/A
	No data in.
	N/A
	UNITED STATES
	205/60R16
	Std.
	Std.
	N/A
	Std.
	Opt.
	1000 lbs
	Std.
	No data lbs
	N/A
	EX V6 coupe AT
	31.90 in.
	Std.
	R&P
	No data in.
	21 miles/gallon
	Std.
	Unlimited mile
	Std.
	N/A
	Std.
	N/A
	N/A
	Std.
	Std.
	N/A

view raw gistfile1.xml hosted with ❤ by GitHub

That's it, just thought I'd share VIN API's Phase II.

]]>

VIN API – VIN Decoder for anyone

Fri, 19 Feb 2010 17:45:11 +0000

UPDATES:
See Phase II details for complete dataset information.
Take a look at the PHP examples and the .NET examples.
And ... while it's been great being able to give this information away freely for about a year now, we have to share some of the cost with our users, so please read about our pricing model.
END UPDATES

VIN API came about through lots of work on a current project of ours - Mr. Quotey. We are dealing with auto insurance and wanted a way to decode VINs. The other solutions we found (API-wise) were too expensive for our small, unfunded startup. So like the way most great things come about, we decided to build our own VIN decoding API.

Using VIN API:

This is explained in detail at VIN API's site, but I will give you a look at what it does here.

If you use Ruby on Rails like I do, then you have the option to use ActiveResource:

	class VinApi < ActiveResource::Base
	headers["X-VinApiKey"] = "YOUR_API_KEY_GOES_HERE"
	self.site = "http://vinapi.skizmo.com"
	self.element_name = "vin"
	end

view raw gistfile1.rb hosted with ❤ by GitHub

Then you can use it like this:

Current Limitations:

Right now each account is limited to 20 VIN requests a month, we are looking to take it slow and prevent abuse. If you do need more VIN decodings a month, feel free to let us know at Mr. Quotey, we'd be happy to up the max for your account.

Where to next?:

It is too soon to really tell. We'd like your feedback and to know if this service is useful. If it gets enough buzz, we would probably pursue it a bit more and drop the monthly limitations.

]]>