GeoCodio Batch API / Macro

I've been using GeoCodio's API to geocode addresses in Alteryx. I've even made a little macro for it, even though I'm fairly new at both Alteryx macros and APIs. It works so far, but I'd like to speed it up by switching to the batch address API.

I'm not sure how to format the URL in Alteryx to include multiple addresses. I've been trying to figure it out from the GeoCodio Documentation and Googling but I haven't made headway so far. I'm very much a beginner with using APIs.

Is anyone else using GeoCodio's batch geocoding API in Alteryx successfully? Or familiar enough in general to point me in the right direction? Any help is greatly appreciated!

I'm attaching my single address URL macro for the GeoCodio API. Note that it requires an API key to use, which are free for their starter tier. Below is the macro workflow with the single address API URL shown.

GeoCodio API with Formula.PNG

Test Geocodio API Macro EW.yxzp

Macros

API

Help

Accepted answers

hellyars

@EW

@BrandonB

This works. The workflow transmits the query address and receives, parses, and cleans the results.

See Brandon's explanation for how to setup the Download tool here.

The workflow uses the JSON Array sample data from GeoCod.io's Batch Addresses example. It is added to the Download Tool's Payload tab - per Brandon's instructions.

Swap out Your_API_Key with your real API key at the end of the URL field in the Text Input tool.

I hope this helps.

GeoCode_BatchAddresses.yxzp

hellyars

@EW So far the solution works great for me.

I added a few tools that concatenate the addresses into a simple JSON array. You can then point the Payload tab to this field instead of cutting and pasting.

Step 1. Addresses start in Field1.

Step 2. Use a Formula Tool to add a quote at the front and beginning of each Address record. '"'+[Address]+'"'

Step 3. Use a Summarize Tool to Concatenate the Address field. Set Start to [ Set Separator to , Set End to ].

Step 4. In my workflow I append the Concatenated Address field to the URL field. See first image above.

Step 5. Set Payload to Take Query String/Body/ from Field = Address

All comments

Luke_C

Hi @EW

Based on the documentation, you wouldn't send the data in the URL. You would instead send it as a payload through the download tool. It accepts a few formats. This could be accomplished mainly through the summarize tool & json build tool.

Can you provide a few sample records? I only see one in the attachment.

Thank you @Luke_C! I'm attaching an updated version of my example file with three addresses.

I'm not familiar with composing payloads for the download tool, I'll need to see if I can figure that out. But your answer definitely points me in the right direction!

Test Geocodio API Macro EW 2.yxzp

Luke_C

Hi @EW

Here's something that will get you going in the right direction. JSON can be tricky so let us know if you run into any issues.

Test Geocodio API Macro EW 2.yxmd

Thanks so much for your help @Luke_C! I am still stuck on this, JSON is definitely tricky!

I tested the JSON field and other parameters in Postman and appears to work correctly, but it's still not working in Alteryx. The error it gives after the download tool is:

{"error":"Invalid API key","_warnings":["Ignoring parameter \"Content-Type\" as it was not expected. See full list of valid parameters here: https:\/\/www.geocod.io\/docs\/","Ignoring parameter \"JSON\" as it was not expected. See full list of valid parameters here: https:\/\/www.geocod.io\/docs\/"]}

I've triple checked that my API key works with the single address API, and in Postman. I've tried adding it on the Header tab as either a constant value or the value from the api_key field. Playing around with other settings as well, still getting the invalid API key error.

I really appreciate your help on this!

Luke_C

Hi @EW

It's good that it's working in postman. Can you post the configurations from there?

Not sure if this is the right way of sharing, but the Postman configuration screens look like this:

postman 1.PNG

postman 2.PNG

postman 3.PNG

I was able to get past the Invalid API error in Alteryx by checking api_key on the Payload tab instead of including it on the Headers tab. It's giving me a different error now, and still no coordinates. The error is below, I starred out my API key.

{"results":{"JSON":{"query":"{\"1\":{\"street\":\"3345 Michelson Dr\",\"postal_code\":\"92612\",\"city\":\"Irvine\",\"state\":\"CA\"},\"2\":{\"street\":\"315 E Eisenhower Pkwy\",\"postal_code\":\"48108\",\"city\":\"Ann Arbor\",\"state\":\"MI\"},\"3\":{\"street\":\"12303 Airport Way\",\"postal_code\":\"80021\",\"city\":\"Broomfield\",\"state\":\"CO\"}}","response":{"error":"The address query string length is too long","results":[]}},"api_key":{"query":"*************************************","response":{"error":"Could not geocode address. Postal code or city required.","results":[]}}}}

Luke_C

hmm I'm honestly not sure, it's tough to troubleshoot without having access. My next step would be wrapping the JSON in square brackets to rule that out. Since it's working in postman there's probably something silly causing the issue in Alteryx.

hellyars

@EW Did you ever sort out a working solution? I have a very similar task. I need to convert supplier addresses to lat - long. I am using GeoCodio, but had not yet tried the API approach.

@hellyars no, I still haven't gotten the batch GeoCodio API to work, unfortunately. I sort of put it aside for the time being.

The one address at a time GeoCodio API works for me in Alteryx, just slowly. Still my preferred geocoding tool so far, although I wish I could figure out the batch version!

hellyars

@EW

@BrandonB

This works. The workflow transmits the query address and receives, parses, and cleans the results.

See Brandon's explanation for how to setup the Download tool here.

The workflow uses the JSON Array sample data from GeoCod.io's Batch Addresses example. It is added to the Download Tool's Payload tab - per Brandon's instructions.

Swap out Your_API_Key with your real API key at the end of the URL field in the Text Input tool.

I hope this helps.

GeoCode_BatchAddresses.yxzp

hellyars

@EW So far the solution works great for me.

I added a few tools that concatenate the addresses into a simple JSON array. You can then point the Payload tab to this field instead of cutting and pasting.

Step 1. Addresses start in Field1.

Step 2. Use a Formula Tool to add a quote at the front and beginning of each Address record. '"'+[Address]+'"'

Step 3. Use a Summarize Tool to Concatenate the Address field. Set Start to [ Set Separator to , Set End to ].

Step 4. In my workflow I append the Concatenated Address field to the URL field. See first image above.

Step 5. Set Payload to Take Query String/Body/ from Field = Address

Yes!! @hellyars thank you so much - this seems to be working great!

Quick Links

This months top contributors

atcodedog05 19598

Qiu 15867

binu_acs 15708

MarqueeCrew 13708

apathetichell 13703