{"id":163,"date":"2023-08-12T03:14:39","date_gmt":"2023-08-12T03:14:39","guid":{"rendered":"https:\/\/fastopendata.com\/?page_id=163"},"modified":"2023-08-17T00:19:45","modified_gmt":"2023-08-17T00:19:45","slug":"quickstart","status":"publish","type":"page","link":"https:\/\/fastopendata.com\/?page_id=163","title":{"rendered":"Quickstart"},"content":{"rendered":"\n<h2 class=\"wp-block-heading has-primary-color has-text-color\">Note: We're in closed alpha testing, so our servers are not working for requesting API keys yet! <\/h2>\n\n\n\n<p>Follow these steps to install the FastOpenData client, get a free API key, and make your first request.<\/p>\n\n\n\n<h1 class=\"wp-block-heading\">Step 1: Install the client<\/h1>\n\n\n\n<p>Use <code>pip<\/code> to install the FastOpenData client. We recommend using a Python virtual environment and making sure that you're using the most recent version of <code>pip<\/code>.  The client is supported for Python 3.6 and newer.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>pip install fastopendata-client<\/code><\/pre>\n\n\n\n<p>After installation is complete, you can test your client by asking for help:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>fastopendata --help<\/code><\/pre>\n\n\n\n<p>You should see a brief help message.<\/p>\n\n\n\n<h1 class=\"wp-block-heading\">Step 2: Get a free API key<\/h1>\n\n\n\n<p>In order to use the FastOpenData service, you'll need an API key to include with each request. Use the client to get one:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>fastopendata get-api-key<\/code><\/pre>\n\n\n\n<p>You will be prompted to enter your email address. As soon as you've done so, the client will print your new API key to the terminal. Copy it somewhere; you'll need it for the next step.<\/p>\n\n\n\n<h1 class=\"wp-block-heading\">Step 3: Make a request<\/h1>\n\n\n\n<p>You can use the client to request data about a specific request like so. Note: be sure to include the double-quotes surrounding your API key and the address.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>fastopendata get --api-key=\"&lt;YOUR_API_KEY_HERE&gt;\" --free-form-query=\"1984 Lower Hawthorne Trail\"<\/code><\/pre>\n\n\n\n<p>If all goes as expected, you'll see a JSON blob containing data about the address. <\/p>\n","protected":false},"excerpt":{"rendered":"<p>Note: We&#8217;re in closed alpha testing, so our servers are not working for requesting API keys yet! Follow these steps to install the FastOpenData client, get a free API&#8230;<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"page-with-left-sidebar","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"class_list":["post-163","page","type-page","status-publish","hentry"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/fastopendata.com\/index.php?rest_route=\/wp\/v2\/pages\/163","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/fastopendata.com\/index.php?rest_route=\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/fastopendata.com\/index.php?rest_route=\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/fastopendata.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/fastopendata.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=163"}],"version-history":[{"count":7,"href":"https:\/\/fastopendata.com\/index.php?rest_route=\/wp\/v2\/pages\/163\/revisions"}],"predecessor-version":[{"id":222,"href":"https:\/\/fastopendata.com\/index.php?rest_route=\/wp\/v2\/pages\/163\/revisions\/222"}],"wp:attachment":[{"href":"https:\/\/fastopendata.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=163"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}