{"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:consumerfinance/get-datasets":{"get":{"operationId":"finance_consumerfinance_get_datasets","summary":"Get a list of all datasets.","description":"GET /data","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:consumerfinance/get-dataset-hmda":{"get":{"operationId":"finance_consumerfinance_get_dataset_hmda","summary":"Get metadata for this dataset.","description":"GET /data/hmda","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:consumerfinance/get-concept-hmda":{"get":{"operationId":"finance_consumerfinance_get_concept_hmda","summary":"Get information about a particular concept in this dataset.","description":"GET /data/hmda/concept/{concept}","tags":["finance"],"parameters":[{"name":"concept","in":"query","required":true,"description":"Name of concept","schema":{"type":"string","description":"Name of concept"}}],"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:consumerfinance/query-slice-hmda":{"get":{"operationId":"finance_consumerfinance_query_slice_hmda","summary":"Query a slice in this dataset.","description":"GET /data/hmda/slice/{slice}","tags":["finance"],"parameters":[{"name":"slice","in":"query","required":true,"description":"Name of slice","schema":{"type":"string","description":"Name of slice"}},{"name":"$select","in":"query","required":false,"description":"Fields to return, separated by commas.","schema":{"type":"string","description":"Fields to return, separated by commas."}},{"name":"$where","in":"query","required":false,"description":"Conditions to search for in the slice, in SQL WHERE style.","schema":{"type":"string","description":"Conditions to search for in the slice, in SQL WHERE style."}},{"name":"$group","in":"query","required":false,"description":"Fields to group by, summarizing the data, separated by commas.","schema":{"type":"string","description":"Fields to group by, summarizing the data, separated by commas."}},{"name":"$limit","in":"query","required":false,"description":"Number of records to return, 100 by default. Enter 0 for no limit.","schema":{"type":"integer","description":"Number of records to return, 100 by default. Enter 0 for no limit."}},{"name":"$offset","in":"query","required":false,"description":"Number of records to skip.","schema":{"type":"integer","description":"Number of records to skip."}},{"name":"$orderBy","in":"query","required":false,"description":"Fields to order by, separated by commas. ASC and DESC can be used to modify the order.","schema":{"type":"string","description":"Fields to order by, separated by commas. ASC and DESC can be used to modify the order."}},{"name":"$callback","in":"query","required":false,"description":"JavaScript callback to invoke. Only useful with JSONP requests.","schema":{"type":"string","description":"JavaScript callback to invoke. Only useful with JSONP requests."}}],"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:consumerfinance/get-slice-metadata-hmda":{"get":{"operationId":"finance_consumerfinance_get_slice_metadata_hmda","summary":"Get the metadata for a slice in this dataset.","description":"GET /data/hmda/slice/{slice}/metadata","tags":["finance"],"parameters":[{"name":"slice","in":"query","required":true,"description":"Name of slice","schema":{"type":"string","description":"Name of slice"}}],"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:consumerfinance/get-dataset":{"get":{"operationId":"finance_consumerfinance_get_dataset","summary":"Get metadata about a dataset.","description":"GET /data/{dataset}","tags":["finance"],"parameters":[{"name":"dataset","in":"query","required":true,"description":"Name of dataset","schema":{"type":"string","description":"Name of dataset"}}],"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"}}}}}}}