{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/places:metadapi/get-zipc-v1":{"get":{"operationId":"places_metadapi_get_zipc_v1","summary":"Validate License Key","description":"GET /zipc/v1","tags":["places"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:metadapi/get-distance":{"get":{"operationId":"places_metadapi_get_distance","summary":"Distance Between 2 Zip Codes","description":"GET /zipc/v1/distance","tags":["places"],"parameters":[{"name":"zipCode1","in":"query","required":true,"description":"Zip Code 1","schema":{"type":"string","description":"Zip Code 1"}},{"name":"zipCode2","in":"query","required":true,"description":"Zip Code 2","schema":{"type":"string","description":"Zip Code 2"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:metadapi/get-msagroups":{"get":{"operationId":"places_metadapi_get_msagroups","summary":"List All MSA Groups","description":"GET /zipc/v1/msagroups","tags":["places"],"parameters":[{"name":"limit","in":"query","required":true,"description":"Number of records to return in each page. Max value: 50.","schema":{"type":"integer","description":"Number of records to return in each page. Max value: 50."}},{"name":"offset","in":"query","required":true,"description":"Offset is the position in the dataset to start retrieval of records.","schema":{"type":"integer","description":"Offset is the position in the dataset to start retrieval of records."}},{"name":"stateCode","in":"query","required":false,"description":"Parameter for state code.","schema":{"type":"string","description":"Parameter for state code."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:metadapi/get-msagroups-msacode":{"get":{"operationId":"places_metadapi_get_msagroups_msacode","summary":"Metro/Micro Statistical Area Details","description":"GET /zipc/v1/msagroups/{msaCode}","tags":["places"],"parameters":[{"name":"msaCode","in":"query","required":true,"description":"5 digit MSA (Metropolitan Statistical Area) code.","schema":{"type":"string","description":"5 digit MSA (Metropolitan Statistical Area) code."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:metadapi/get-radius":{"get":{"operationId":"places_metadapi_get_radius","summary":"Zip Code Radius","description":"GET /zipc/v1/radius","tags":["places"],"parameters":[{"name":"zipCode","in":"query","required":true,"description":"5 Digit US Zip Code","schema":{"type":"string","description":"5 Digit US Zip Code"}},{"name":"radius","in":"query","required":true,"description":"Radius distance. Max 322 km or 200 mi","schema":{"type":"integer","description":"Radius distance. Max 322 km or 200 mi"}},{"name":"uom","in":"query","required":true,"description":"Unit of Measure","schema":{"type":"string","enum":["mi","km"],"description":"Unit of Measure"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:metadapi/get-zipcodes":{"get":{"operationId":"places_metadapi_get_zipcodes","summary":"List all Zip Codes","description":"GET /zipc/v1/zipcodes","tags":["places"],"parameters":[{"name":"offset","in":"query","required":false,"description":"Offset is the position in the dataset to start retrieval of records.","schema":{"type":"number","description":"Offset is the position in the dataset to start retrieval of records."}},{"name":"limit","in":"query","required":false,"description":"Number of records to return in each page.","schema":{"type":"number","description":"Number of records to return in each page."}},{"name":"zipcode","in":"query","required":false,"description":"5 Digit Zip Code query parameter. Can have multiple values (separated by comma).","schema":{"type":"string","description":"5 Digit Zip Code query parameter. Can have multiple values (separated by comma)."}},{"name":"uspsMainCityKey","in":"query","required":false,"description":"Parameter for USPS City / Town key identifier for the main city of the zip code.","schema":{"type":"string","description":"Parameter for USPS City / Town key identifier for the main city of the zip code."}},{"name":"zipClassificationCode","in":"query","required":false,"description":"Parameter for zipClassificationCode","schema":{"type":"string","description":"Parameter for zipClassificationCode"}},{"name":"uspsFacilityCode","in":"query","required":false,"description":"Parameter for facility code.","schema":{"type":"string","description":"Parameter for facility code."}},{"name":"uspsDeliveryCode","in":"query","required":false,"description":"Parameter for delivery code.","schema":{"type":"string","description":"Parameter for delivery code."}},{"name":"uspsCarrierRouteSortCode","in":"query","required":false,"description":"Parameter for carrier route sort code.","schema":{"type":"string","description":"Parameter for carrier route sort code."}},{"name":"uniqueZipNameInd","in":"query","required":false,"description":"Parameter for unique zip name indicator.","schema":{"type":"boolean","description":"Parameter for unique zip name indicator."}},{"name":"uspsFinanceNumber","in":"query","required":false,"description":"Parameter for finance number.","schema":{"type":"string","description":"Parameter for finance number."}},{"name":"stateCode","in":"query","required":false,"description":"Parameter for state code.","schema":{"type":"string","description":"Parameter for state code."}},{"name":"stateFipsCode","in":"query","required":false,"description":"Parameter for State FIPS code.","schema":{"type":"string","description":"Parameter for State FIPS code."}},{"name":"countyFipsCode","in":"query","required":false,"description":"Parameter for county FIPS code.","schema":{"type":"string","description":"Parameter for county FIPS code."}},{"name":"divisionCode","in":"query","required":false,"description":"Parameter for division code.","schema":{"type":"string","description":"Parameter for division code."}},{"name":"regionCode","in":"query","required":false,"description":"Parameter for region code.","schema":{"type":"string","description":"Parameter for region code."}},{"name":"msaCode","in":"query","required":false,"description":"Parameter for msaCode.","schema":{"type":"string","description":"Parameter for msaCode."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:metadapi/get-zipcode":{"get":{"operationId":"places_metadapi_get_zipcode","summary":"Zip Code Details","description":"GET /zipc/v1/zipcodes/{zipcode}","tags":["places"],"parameters":[{"name":"zipcode","in":"query","required":true,"description":"5 Digit US Zip Code","schema":{"type":"string","description":"5 Digit US Zip Code"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}