{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:greip/get-asnlookup":{"get":{"operationId":"open_data_greip_get_asnlookup","summary":"ASNLookup endpoint: This method helps you lookup any AS Number. It returns the type, organisation details,…","description":"GET /ASNLookup","tags":["open-data"],"parameters":[{"name":"key","in":"query","required":true,"description":"Your API Key. Each user has a unique API Key that can be used to access the API functions. If you don't have an account yet, please create…","schema":{"type":"string","description":"Your API Key. Each user has a unique API Key that can be used to access the API functions. If you don't have an account yet, please create…"}},{"name":"asn","in":"query","required":true,"description":"The AS Number you want to lookup","schema":{"type":"string","description":"The AS Number you want to lookup"}},{"name":"isList","in":"query","required":false,"description":"Set this to true if you want to list all routes of both IPv4 and IPv6.","schema":{"type":"string","description":"Set this to true if you want to list all routes of both IPv4 and IPv6."}},{"name":"format","in":"query","required":false,"description":"Sets the format of the API response. JSON is the default format.","schema":{"type":"string","description":"Sets the format of the API response. JSON is the default format."}}],"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":"live"}},"/v1/open-data:greip/get-binlookup":{"get":{"operationId":"open_data_greip_get_binlookup","summary":"This method helps you validate any BIN/IIN number and retrieve the full details related to the bank, brand,…","description":"GET /BINLookup","tags":["open-data"],"parameters":[{"name":"key","in":"query","required":true,"description":"Your API Key. Each user has a unique API Key that can be used to access the API functions. If you don't have an account yet, please create…","schema":{"type":"string","description":"Your API Key. Each user has a unique API Key that can be used to access the API functions. If you don't have an account yet, please create…"}},{"name":"bin","in":"query","required":true,"description":"The BIN/IIN you want to lookup/validate.","schema":{"type":"string","description":"The BIN/IIN you want to lookup/validate."}},{"name":"format","in":"query","required":false,"description":"Sets the format of the API response. JSON is the default format.","schema":{"type":"string","description":"Sets the format of the API response. JSON is the default format."}}],"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":"live"}},"/v1/open-data:greip/get-bulk-lookup":{"get":{"operationId":"open_data_greip_get_bulk_lookup","summary":"BulkLookup endpoint: Returns the geolocation data of multiple IP Addresses.","description":"GET /BulkLookup","tags":["open-data"],"parameters":[{"name":"key","in":"query","required":true,"description":"Your API Key. Each user has a unique API Key that can be used to access the API functions. If you don't have an account yet, please create…","schema":{"type":"string","description":"Your API Key. Each user has a unique API Key that can be used to access the API functions. If you don't have an account yet, please create…"}},{"name":"ips","in":"query","required":true,"description":"The IP Addresses you want to lookup. It's a CSV (Comma Separated Values)","schema":{"type":"string","description":"The IP Addresses you want to lookup. It's a CSV (Comma Separated Values)"}},{"name":"params","in":"query","required":false,"description":"The modules you want to use of the request. It's a CSV (Comma Separated Values)","schema":{"type":"string","description":"The modules you want to use of the request. It's a CSV (Comma Separated Values)"}},{"name":"lang","in":"query","required":false,"description":"Used to inform the API to retrieve the response in your native language.","schema":{"type":"string","description":"Used to inform the API to retrieve the response in your native language."}},{"name":"format","in":"query","required":false,"description":"Sets the format of the API response. JSON is the default format.","schema":{"type":"string","description":"Sets the format of the API response. JSON is the default format."}}],"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":"live"}},"/v1/open-data:greip/get-country":{"get":{"operationId":"open_data_greip_get_country","summary":"Country endpoint: Returns the information of a specific country by passing the `countrCode`.","description":"GET /Country","tags":["open-data"],"parameters":[{"name":"key","in":"query","required":true,"description":"Your API Key. Each user has a unique API Key that can be used to access the API functions. If you don't have an account yet, please create…","schema":{"type":"string","description":"Your API Key. Each user has a unique API Key that can be used to access the API functions. If you don't have an account yet, please create…"}},{"name":"CountryCode","in":"query","required":true,"description":"The Country Code of the country you want to fetch it's data.","schema":{"type":"string","description":"The Country Code of the country you want to fetch it's data."}},{"name":"params","in":"query","required":false,"description":"The modules you want to use of the request. It's a CSV (Comma Separated Values)","schema":{"type":"string","description":"The modules you want to use of the request. It's a CSV (Comma Separated Values)"}},{"name":"lang","in":"query","required":false,"description":"Used to inform the API to retrieve the response in your native language.","schema":{"type":"string","description":"Used to inform the API to retrieve the response in your native language."}},{"name":"format","in":"query","required":false,"description":"Sets the format of the API response. JSON is the default format.","schema":{"type":"string","description":"Sets the format of the API response. JSON is the default format."}}],"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":"live"}},"/v1/open-data:greip/get-geo-ip":{"get":{"operationId":"open_data_greip_get_geo_ip","summary":"Returns the geolocation data of the visitor.","description":"GET /GeoIP","tags":["open-data"],"parameters":[{"name":"key","in":"query","required":true,"description":"Your API Key. Each user has a unique API Key that can be used to access the API functions. If you don't have an account yet, please create…","schema":{"type":"string","description":"Your API Key. Each user has a unique API Key that can be used to access the API functions. If you don't have an account yet, please create…"}},{"name":"params","in":"query","required":false,"description":"The modules you want to use of the request. It's a CSV (Comma Separated Values)","schema":{"type":"string","description":"The modules you want to use of the request. It's a CSV (Comma Separated Values)"}},{"name":"lang","in":"query","required":false,"description":"Used to inform the API to retrieve the response in your native language.","schema":{"type":"string","description":"Used to inform the API to retrieve the response in your native language."}},{"name":"format","in":"query","required":false,"description":"Sets the format of the API response. JSON is the default format.","schema":{"type":"string","description":"Sets the format of the API response. JSON is the default format."}}],"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":"live"}},"/v1/open-data:greip/get-iplookup":{"get":{"operationId":"open_data_greip_get_iplookup","summary":"Returns the geolocation data of a specific IP Address.","description":"GET /IPLookup","tags":["open-data"],"parameters":[{"name":"key","in":"query","required":true,"description":"Your API Key. Each user has a unique API Key that can be used to access the API functions. If you don't have an account yet, please create…","schema":{"type":"string","description":"Your API Key. Each user has a unique API Key that can be used to access the API functions. If you don't have an account yet, please create…"}},{"name":"ip","in":"query","required":true,"description":"The IP Address you want to lookup.","schema":{"type":"string","description":"The IP Address you want to lookup."}},{"name":"params","in":"query","required":false,"description":"The modules you want to use of the request. It's a CSV (Comma Separated Values)","schema":{"type":"string","description":"The modules you want to use of the request. It's a CSV (Comma Separated Values)"}},{"name":"lang","in":"query","required":false,"description":"Used to inform the API to retrieve the response in your native language.","schema":{"type":"string","description":"Used to inform the API to retrieve the response in your native language."}},{"name":"format","in":"query","required":false,"description":"Sets the format of the API response. JSON is the default format.","schema":{"type":"string","description":"Sets the format of the API response. JSON is the default format."}}],"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":"live"}},"/v1/open-data:greip/get-bad-words":{"get":{"operationId":"open_data_greip_get_bad_words","summary":"badWords endpoint: Detects whether user inputs contain profanity or not.","description":"GET /badWords","tags":["open-data"],"parameters":[{"name":"key","in":"query","required":true,"description":"Your API Key. Each user has a unique API Key that can be used to access the API functions. If you don't have an account yet, please create…","schema":{"type":"string","description":"Your API Key. Each user has a unique API Key that can be used to access the API functions. If you don't have an account yet, please create…"}},{"name":"text","in":"query","required":true,"description":"The text you want to check.","schema":{"type":"string","description":"The text you want to check."}},{"name":"listBadWords","in":"query","required":false,"description":"Set to `yes` to list the bad-words as an Array.","schema":{"type":"string","description":"Set to `yes` to list the bad-words as an Array."}},{"name":"scoreOnly","in":"query","required":false,"description":"Set to `yes` to return only the score of the text and whether it's safe or not.","schema":{"type":"string","description":"Set to `yes` to return only the score of the text and whether it's safe or not."}},{"name":"format","in":"query","required":false,"description":"Sets the format of the API response. JSON is the default format.","schema":{"type":"string","description":"Sets the format of the API response. JSON is the default format."}}],"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":"live"}},"/v1/open-data:greip/get-validate-email":{"get":{"operationId":"open_data_greip_get_validate_email","summary":"This method can be used as an extra-layer of your system for validating email addresses.","description":"GET /validateEmail","tags":["open-data"],"parameters":[{"name":"key","in":"query","required":true,"description":"Your API Key. Each user has a unique API Key that can be used to access the API functions. If you don't have an account yet, please create…","schema":{"type":"string","description":"Your API Key. Each user has a unique API Key that can be used to access the API functions. If you don't have an account yet, please create…"}},{"name":"email","in":"query","required":true,"description":"The Email Address you want to validate.","schema":{"type":"string","description":"The Email Address you want to validate."}},{"name":"format","in":"query","required":false,"description":"Sets the format of the API response. JSON is the default format.","schema":{"type":"string","description":"Sets the format of the API response. JSON is the default format."}}],"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":"live"}},"/v1/open-data:greip/get-validate-phone":{"get":{"operationId":"open_data_greip_get_validate_phone","summary":"This method can be used as an extra-layer of your system for validating phone numbers.","description":"GET /validatePhone","tags":["open-data"],"parameters":[{"name":"key","in":"query","required":true,"description":"Your API Key. Each user has a unique API Key that can be used to access the API functions. If you don't have an account yet, please create…","schema":{"type":"string","description":"Your API Key. Each user has a unique API Key that can be used to access the API functions. If you don't have an account yet, please create…"}},{"name":"phone","in":"query","required":true,"description":"The Phone Number you want to validate.","schema":{"type":"string","description":"The Phone Number you want to validate."}},{"name":"countryCode","in":"query","required":true,"description":"The ISO 3166-1 alpha-2 format of the country code of the phone number.","schema":{"type":"string","description":"The ISO 3166-1 alpha-2 format of the country code of the phone number."}},{"name":"format","in":"query","required":false,"description":"Sets the format of the API response. JSON is the default format.","schema":{"type":"string","description":"Sets the format of the API response. JSON is the default format."}}],"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":"live"}}},"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"}}}}}}}