Skip to content

ZipCountiesApi.md

Latest commit

 

History

History
116 lines (80 loc) · 3.85 KB

ZipCountiesApi.md

File metadata and controls

116 lines (80 loc) · 3.85 KB

vericred_client.ZipCountiesApi

All URIs are relative to https://api.vericred.com/

Method HTTP request Description
get_zip_counties GET /zip_counties Search for Zip Counties
show_zip_county GET /zip_counties/{id} Show an individual ZipCounty

get_zip_counties

ZipCountiesResponse get_zip_counties(zip_prefix)

Search for Zip Counties

Our Plan endpoints require a zip code and a fips (county) code. This is because plan pricing requires both of these elements. Users are unlikely to know their fips code, so we provide this endpoint to look up a ZipCounty by zip code and return both the selected zip and fips codes.

Example

from __future__ import print_statement
import time
import vericred_client
from vericred_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Vericred-Api-Key
vericred_client.configuration.api_key['Vericred-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# vericred_client.configuration.api_key_prefix['Vericred-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = vericred_client.ZipCountiesApi()
zip_prefix = '1002' # str | Partial five-digit Zip

try: 
    # Search for Zip Counties
    api_response = api_instance.get_zip_counties(zip_prefix)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZipCountiesApi->get_zip_counties: %s\n" % e)

Parameters

Name Type Description Notes
zip_prefix str Partial five-digit Zip

Return type

ZipCountiesResponse

Authorization

Vericred-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

show_zip_county

ZipCountyResponse show_zip_county(id)

Show an individual ZipCounty

Our Plan endpoints require a zip code and a fips (county) code. This is because plan pricing requires both of these elements. Users are unlikely to know their fips code, so we provide this endpoint to returns the details for a ZipCounty by zip code and return both the selected zip and fips codes.

Example

from __future__ import print_statement
import time
import vericred_client
from vericred_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Vericred-Api-Key
vericred_client.configuration.api_key['Vericred-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# vericred_client.configuration.api_key_prefix['Vericred-Api-Key'] = 'Bearer'

# create an instance of the API class
api_instance = vericred_client.ZipCountiesApi()
id = 12345 # int | Unique ID for ZipCounty

try: 
    # Show an individual ZipCounty
    api_response = api_instance.show_zip_county(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZipCountiesApi->show_zip_county: %s\n" % e)

Parameters

Name Type Description Notes
id int Unique ID for ZipCounty

Return type

ZipCountyResponse

Authorization

Vericred-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]