{"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/finance:hsbc-branches/get-open-banking-v2-2-branches":{"get":{"operationId":"finance_hsbc_branches_get_open_banking_v2_2_branches","summary":"This API will return the branch details for all branches and is prepared to the Open Banking standards as…","description":"GET /open-banking/v2.2/branches","tags":["finance"],"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":"live"}},"/v1/finance:hsbc-branches/get-x-open-banking-v2-2-branches-country-country":{"get":{"operationId":"finance_hsbc_branches_get_x_open_banking_v2_2_branches_country_country","summary":"This extended API will return the branch details for all branches in the specified country. It is based-on…","description":"GET /x-open-banking/v2.2/branches/country/{country}","tags":["finance"],"parameters":[{"name":"country","in":"query","required":true,"description":"The ISO country code e.g. "GB"","schema":{"type":"string","description":"The ISO country code e.g. "GB""}}],"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/finance:hsbc-branches/get-x-open-banking-v2-2-branches-country-country-town-town":{"get":{"operationId":"finance_hsbc_branches_get_x_open_banking_v2_2_branches_country_country_town_town","summary":"This extended API will return the branch details for all branches in the specified town. It is based-on the…","description":"GET /x-open-banking/v2.2/branches/country/{country}/town/{town}","tags":["finance"],"parameters":[{"name":"country","in":"query","required":true,"description":"The ISO country code e.g. "GB"","schema":{"type":"string","description":"The ISO country code e.g. "GB""}},{"name":"town","in":"query","required":true,"description":"Town name, not case sensitive","schema":{"type":"string","description":"Town name, not case sensitive"}}],"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/finance:hsbc-branches/get-x-open-banking-v2-2-branches-geo-location-lat-latitude-l":{"get":{"operationId":"finance_hsbc_branches_get_x_open_banking_v2_2_branches_geo_location_lat_latitude_l","summary":"This API will return the branch details for all branches within a specified radius (1 to 10 miles) of the…","description":"GET /x-open-banking/v2.2/branches/geo-location/lat/{latitude}/long/{longitude}","tags":["finance"],"parameters":[{"name":"latitude","in":"query","required":true,"description":"Positive or negative decimal value in degrees. eg "51.50551621597067"","schema":{"type":"string","description":"Positive or negative decimal value in degrees. eg "51.50551621597067""}},{"name":"longitude","in":"query","required":true,"description":"Positive or negative decimal value in degrees. eg "-0.0180120225995"","schema":{"type":"string","description":"Positive or negative decimal value in degrees. eg "-0.0180120225995""}},{"name":"radius","in":"query","required":true,"description":"Number of miles (1 to 10) as an integer. Default = 1","schema":{"type":"number","description":"Number of miles (1 to 10) as an integer. Default = 1"}}],"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/finance:hsbc-branches/get-x-open-banking-v2-2-branches-postcode-postcode":{"get":{"operationId":"finance_hsbc_branches_get_x_open_banking_v2_2_branches_postcode_postcode","summary":"This extended API will return the branch details for all branches within a 5 mile radius of the specified…","description":"GET /x-open-banking/v2.2/branches/postcode/{postcode}","tags":["finance"],"parameters":[{"name":"postcode","in":"query","required":true,"description":"Letters and numerals only. No spaces or special characters. eg. "SW1A1AA"","schema":{"type":"string","description":"Letters and numerals only. No spaces or special characters. eg. "SW1A1AA""}}],"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/finance:hsbc-branches/get-x-open-banking-v2-2-branches-sortcode-sortcode":{"get":{"operationId":"finance_hsbc_branches_get_x_open_banking_v2_2_branches_sortcode_sortcode","summary":"This extended API will return the branch details for a branch specified by its sort code. It is based-on the…","description":"GET /x-open-banking/v2.2/branches/sortcode/{sortcode}","tags":["finance"],"parameters":[{"name":"sortcode","in":"query","required":true,"description":"6 digit number with no spaces or special characters. eg. "400003"","schema":{"type":"string","description":"6 digit number with no spaces or special characters. eg. "400003""}}],"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"}}}}}}}