{"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:nsidc/facets":{"get":{"operationId":"open_data_nsidc_facets","summary":"View the facet information corresponding to a search","description":"GET /Facets","tags":["open-data"],"parameters":[{"name":"searchTerms","in":"query","required":false,"description":"URL-encoded keyword or keywords desired by the client; OpenSearch 1.1","schema":{"type":"string","description":"URL-encoded keyword or keywords desired by the client; OpenSearch 1.1"}},{"name":"count","in":"query","required":false,"description":"The number of search results per page desired by the client; OpenSearch 1.1","schema":{"type":"integer","default":25,"description":"The number of search results per page desired by the client; OpenSearch 1.1"}},{"name":"startIndex","in":"query","required":false,"description":"First search result desired by the search client; OpenSearch 1.1","schema":{"type":"integer","default":1,"description":"First search result desired by the search client; OpenSearch 1.1"}},{"name":"spatial","in":"query","required":false,"description":"4 comma separated values - W, S, E, N; OpenSearch-Geo 1.0, \"box\" parameter","schema":{"type":"string","default":"-180.0,-90.0,180.0,90.0","description":"4 comma separated values - W, S, E, N; OpenSearch-Geo 1.0, \"box\" parameter"}},{"name":"sortKeys","in":"query","required":false,"description":"Sort the results by most relevant (default), smallest or largest spatial area, shortest or longest temporal duration, or most recently…","schema":{"type":"string","enum":["score,,desc","spatial_area,,asc","spatial_area,,desc","temporal_duration,,asc","temporal_duration,,desc","updated,,desc"],"default":"score,,desc","description":"Sort the results by most relevant (default), smallest or largest spatial area, shortest or longest temporal duration, or most recently…"}},{"name":"startDate","in":"query","required":false,"description":"The start date in yyyy-mm-dd format","schema":{"type":"string","description":"The start date in yyyy-mm-dd format"}},{"name":"endDate","in":"query","required":false,"description":"The end date in yyyy-mm-dd format","schema":{"type":"string","description":"The end date in yyyy-mm-dd format"}},{"name":"facetFilters","in":"query","required":false,"description":"Describes faceted restrictions on the search. A URL-encoded JSON object where the keys are the names of the facet, and the values are…","schema":{"type":"string","description":"Describes faceted restrictions on the search. A URL-encoded JSON object where the keys are the names of the facet, and the values are…"}},{"name":"source","in":"query","required":false,"description":"Custom parameter for selecting which source to use; the Arctic Data Explorer (ADE) uses data aggregated from many sources, including, but…","schema":{"type":"string","enum":["NSIDC","ADE"],"default":"NSIDC","description":"Custom parameter for selecting which source to use; the Arctic Data Explorer (ADE) uses data aggregated from many sources, including, but…"}}],"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:nsidc/open-search":{"get":{"operationId":"open_data_nsidc_open_search","summary":"Search documents using the OpenSearch 1.1 Specification","description":"GET /OpenSearch","tags":["open-data"],"parameters":[{"name":"searchTerms","in":"query","required":false,"description":"URL-encoded keyword or keywords desired by the client; OpenSearch 1.1","schema":{"type":"string","description":"URL-encoded keyword or keywords desired by the client; OpenSearch 1.1"}},{"name":"count","in":"query","required":false,"description":"The number of search results per page desired by the client; OpenSearch 1.1","schema":{"type":"integer","default":25,"description":"The number of search results per page desired by the client; OpenSearch 1.1"}},{"name":"startIndex","in":"query","required":false,"description":"First search result desired by the search client; OpenSearch 1.1","schema":{"type":"integer","default":1,"description":"First search result desired by the search client; OpenSearch 1.1"}},{"name":"spatial","in":"query","required":false,"description":"4 comma separated values - W, S, E, N; OpenSearch-Geo 1.0, \"box\" parameter","schema":{"type":"string","default":"-180.0,-90.0,180.0,90.0","description":"4 comma separated values - W, S, E, N; OpenSearch-Geo 1.0, \"box\" parameter"}},{"name":"sortKeys","in":"query","required":false,"description":"Sort the results by most relevant (default), smallest or largest spatial area, shortest or longest temporal duration, or most recently…","schema":{"type":"string","enum":["score,,desc","spatial_area,,asc","spatial_area,,desc","temporal_duration,,asc","temporal_duration,,desc","updated,,desc"],"default":"score,,desc","description":"Sort the results by most relevant (default), smallest or largest spatial area, shortest or longest temporal duration, or most recently…"}},{"name":"startDate","in":"query","required":false,"description":"The start date in yyyy-mm-dd format","schema":{"type":"string","description":"The start date in yyyy-mm-dd format"}},{"name":"endDate","in":"query","required":false,"description":"The end date in yyyy-mm-dd format","schema":{"type":"string","description":"The end date in yyyy-mm-dd format"}},{"name":"facetFilters","in":"query","required":false,"description":"Describes faceted restrictions on the search. A URL-encoded JSON object where the keys are the names of the facet, and the values are…","schema":{"type":"string","description":"Describes faceted restrictions on the search. A URL-encoded JSON object where the keys are the names of the facet, and the values are…"}},{"name":"source","in":"query","required":false,"description":"Custom parameter for selecting which source to use; the Arctic Data Explorer (ADE) uses data aggregated from many sources, including, but…","schema":{"type":"string","enum":["NSIDC","ADE"],"default":"NSIDC","description":"Custom parameter for selecting which source to use; the Arctic Data Explorer (ADE) uses data aggregated from many sources, including, but…"}}],"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:nsidc/opensearch-description":{"get":{"operationId":"open_data_nsidc_opensearch_description","summary":"Describes the web interface of NSIDC's data search engine","description":"GET /OpenSearchDescription","tags":["open-data"],"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/open-data:nsidc/id":{"get":{"operationId":"open_data_nsidc_id","summary":"Suggest search terms based on a partial query","description":"GET /suggest","tags":["open-data"],"parameters":[{"name":"q","in":"query","required":true,"description":"Search terms typed into the interface (minimum two characters)","schema":{"type":"string","description":"Search terms typed into the interface (minimum two characters)"}},{"name":"source","in":"query","required":true,"description":"Custom parameter for selecting which source to use; the Arctic Data Explorer (ADE) uses data aggregated from many sources, including, but…","schema":{"type":"string","enum":["NSIDC","ADE"],"default":"NSIDC","description":"Custom parameter for selecting which source to use; the Arctic Data Explorer (ADE) uses data aggregated from many sources, including, but…"}}],"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"}}}}}}}