{"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:digitalnz/get-records-format":{"get":{"operationId":"open_data_digitalnz_get_records_format","summary":"Run queries against DigitalNZ metadata search service.","description":"GET /records.{format}","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":true,"description":"Note - There is a small difference with some field names in the response between JSON and XML. When a field name has more than one word,…","schema":{"type":"string","enum":["json","xml"],"description":"Note - There is a small difference with some field names in the response between JSON and XML. When a field name has more than one word,…"}},{"name":"Authentication-Token","in":"query","required":false,"description":"The DigitalNZ API no longer requires a key to access public content. However, if you plan on using the API regularly, expect to be a high…","schema":{"type":"string","description":"The DigitalNZ API no longer requires a key to access public content. However, if you plan on using the API regularly, expect to be a high…"}},{"name":"text","in":"query","required":false,"description":"This field enables queries based on one or more search terms and provides the functionality of the main search box on…","schema":{"type":"string","description":"This field enables queries based on one or more search terms and provides the functionality of the main search box on…"}},{"name":"and[category][]","in":"query","required":false,"description":"These are the same categories that are used across the tabs in [digitalnz.org](https://digitalnz.org/records?text=&tab=Videos)","schema":{"type":"string","enum":["Newspapers","Images","Books","Articles","Journals","Archives","Audio","Other","Manuscripts","Reference sources","Research papers","Videos","Music Score","Groups","Data","Websites","Sets"],"description":"These are the same categories that are used across the tabs in [digitalnz.org](https://digitalnz.org/records?text=&tab=Videos)"}},{"name":"and[content_partner][]","in":"query","required":false,"description":"Allows filtering for records from a particular Content Partner. Examples: `\"Ministry for Culture and Heritage\"` `\"Trove\"` `\"V.C. Browne &…","schema":{"type":"string","description":"Allows filtering for records from a particular Content Partner. Examples: `\"Ministry for Culture and Heritage\"` `\"Trove\"` `\"V.C. Browne &…"}},{"name":"and[primary_collection][]","in":"query","required":false,"description":"Allows filtering for records from a particular *primary_collection*. Examples: `\"Puke Ariki\"` `\"NZHistory\"` `\"TAPUHI\"` *Tip* - To see a…","schema":{"type":"string","description":"Allows filtering for records from a particular *primary_collection*. Examples: `\"Puke Ariki\"` `\"NZHistory\"` `\"TAPUHI\"` *Tip* - To see a…"}},{"name":"and[collection][]","in":"query","required":false,"description":"Allows filtering for records from a particular Collection. Collections can be thought of as sub-collections or groupings under…","schema":{"type":"string","description":"Allows filtering for records from a particular Collection. Collections can be thought of as sub-collections or groupings under…"}},{"name":"and[usage][]","in":"query","required":false,"schema":{"type":"string","enum":["Share","Modify","Use commercially","All rights reserved","Unknown"]}},{"name":"and[subject][]","in":"query","required":false,"description":"Examples: `\"Cats\"` `\"Weddings\"` `\"climb*\"`","schema":{"type":"string","description":"Examples: `\"Cats\"` `\"Weddings\"` `\"climb*\"`"}},{"name":"and[dc_type][]","in":"query","required":false,"description":"Examples: `\"Conference item\"` `\"Magazines\"`","schema":{"type":"string","description":"Examples: `\"Conference item\"` `\"Magazines\"`"}},{"name":"and[format][]","in":"query","required":false,"description":"Examples: `\"Photolithographs\"` `\"Glass*\"`","schema":{"type":"string","description":"Examples: `\"Photolithographs\"` `\"Glass*\"`"}},{"name":"and[placename][]","in":"query","required":false,"description":"This field can be used for text-based location search. For a more advanced coordinate-based search, see the \"geo_bbox\" field below.…","schema":{"type":"string","description":"This field can be used for text-based location search. For a more advanced coordinate-based search, see the \"geo_bbox\" field below.…"}},{"name":"and[creator][]","in":"query","required":false,"description":"Examples: `\"Revelle Jackson\"` `\"Nicholas Chevalier\"` `\"Rita Angus\"`","schema":{"type":"string","description":"Examples: `\"Revelle Jackson\"` `\"Nicholas Chevalier\"` `\"Rita Angus\"`"}},{"name":"and[title][]","in":"query","required":false,"description":"Examples: `\"Pukeko\"` `\"Club\"` `\"Break*\"`\"","schema":{"type":"string","description":"Examples: `\"Pukeko\"` `\"Club\"` `\"Break*\"`\""}},{"name":"and[date]","in":"query","required":false,"description":"This field can be useful for querying and sorting (see the 'sort' param further down). But it should be noted that, as with some other…","schema":{"type":"string","description":"This field can be useful for querying and sorting (see the 'sort' param further down). But it should be noted that, as with some other…"}},{"name":"and[year]","in":"query","required":false,"description":"This field allows searching specifically by year. The metadata is derived from the same date information that is searchable and returned…","schema":{"type":"string","description":"This field allows searching specifically by year. The metadata is derived from the same date information that is searchable and returned…"}},{"name":"and[decade]","in":"query","required":false,"description":"This field allows searching specifically by decade. The metadata is derived from the same date information that is searchable and returned…","schema":{"type":"string","description":"This field allows searching specifically by decade. The metadata is derived from the same date information that is searchable and returned…"}},{"name":"and[century]","in":"query","required":false,"description":"This field allows searching specifically by century. The metadata is derived from the same date information that is searchable and…","schema":{"type":"string","description":"This field allows searching specifically by century. The metadata is derived from the same date information that is searchable and…"}},{"name":"without[{filter_field}]","in":"query","required":false,"description":"All of the above `and[___][]` filters in this document are also able to be used with this syntax to exclude specific matches. For example…","schema":{"type":"string","description":"All of the above `and[___][]` filters in this document are also able to be used with this syntax to exclude specific matches. For example…"}},{"name":"and[or][{filter_field}][]","in":"query","required":false,"description":"All of the above `and[___][]` filters in this document are also able to be used with the `and[or][___][]` syntax to allow multi-select…","schema":{"type":"string","description":"All of the above `and[___][]` filters in this document are also able to be used with the `and[or][___][]` syntax to allow multi-select…"}},{"name":"and[is_commercial_use]","in":"query","required":false,"description":"Some DigitalNZ partners offer their metadata for use in commercial applications. This content can be identified through the…","schema":{"type":"boolean","description":"Some DigitalNZ partners offer their metadata for use in commercial applications. This content can be identified through the…"}},{"name":"and[has_large_thumbnail_url]","in":"query","required":false,"description":"Filters results to only those records that have an image available in the *large_thumbnail_url* field. **Note:** There is an issue with…","schema":{"type":"string","enum":["Y"],"description":"Filters results to only those records that have an image available in the *large_thumbnail_url* field. **Note:** There is an issue with…"}},{"name":"and[has_lat_lng]","in":"query","required":false,"description":"Filters results to only those records that have latitude and longitude coordinates present in the metadata. *Tip* - To see the location…","schema":{"type":"boolean","enum":[true,false],"description":"Filters results to only those records that have latitude and longitude coordinates present in the metadata. *Tip* - To see the location…"}},{"name":"geo_bbox","in":"query","required":false,"description":"A geographic bounding box scoping a search to a geographic region. Order of latitude-longitude coordinates is north, west, south, east.…","schema":{"type":"string","description":"A geographic bounding box scoping a search to a geographic region. Order of latitude-longitude coordinates is north, west, south, east.…"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated whitelist of fields to be returned. The syntax *\"&fields=verbose\"* can be used to return the bulk of the fields, or you…","schema":{"type":"string","description":"Comma-separated whitelist of fields to be returned. The syntax *\"&fields=verbose\"* can be used to return the bulk of the fields, or you…"}},{"name":"sort","in":"query","required":false,"description":"Used to control the order of the results in conjunction with the *direction* field. - *syndication_date* - is the creation date of the…","schema":{"type":"string","enum":["syndication_date","date"],"description":"Used to control the order of the results in conjunction with the *direction* field. - *syndication_date* - is the creation date of the…"}},{"name":"direction","in":"query","required":false,"description":"Used in conjunction with *sort* to order the results - *asc* - Ascending, oldest first. - *desc* - Descending, newest first.","schema":{"type":"string","enum":["asc","desc"],"default":"asc","description":"Used in conjunction with *sort* to order the results - *asc* - Ascending, oldest first. - *desc* - Descending, newest first."}},{"name":"page","in":"query","required":false,"description":"Specify which page of results to return.","schema":{"type":"integer","default":1,"description":"Specify which page of results to return."}},{"name":"per_page","in":"query","required":false,"description":"The number of records to return per page of search results.","schema":{"type":"integer","default":20,"description":"The number of records to return per page of search results."}},{"name":"facets","in":"query","required":false,"description":"Shows a breakdown of record counts for the specified facets based on the current result set. In the [DigitalNZ search…","schema":{"type":"array","description":"Shows a breakdown of record counts for the specified facets based on the current result set. In the [DigitalNZ search…"}},{"name":"facets_page","in":"query","required":false,"description":"This value specifies which page of facet results to return. Allowing pagination through large lists of facet values.","schema":{"type":"integer","description":"This value specifies which page of facet results to return. Allowing pagination through large lists of facet values."}},{"name":"facets_per_page","in":"query","required":false,"description":"The number of facets to return per page of facet results.","schema":{"type":"integer","default":10,"description":"The number of facets to return per page of facet results."}},{"name":"exclude_filters_from_facets","in":"query","required":false,"description":"This field can be used when filtering into some facets, to maintain the context of the wider facet values. A common use case is to allow…","schema":{"type":"boolean","default":false,"description":"This field can be used when filtering into some facets, to maintain the context of the wider facet values. A common use case is to allow…"}}],"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/open-data:digitalnz/get-records-record-id-format":{"get":{"operationId":"open_data_digitalnz_get_records_record_id_format","summary":"View metadata associated with a single record.","description":"GET /records/{record_id}.{format}","tags":["open-data"],"parameters":[{"name":"record_id","in":"query","required":true,"description":"Every record has a unique, persistent *record_id*.","schema":{"type":"integer","description":"Every record has a unique, persistent *record_id*."},"example":189089},{"name":"format","in":"query","required":true,"description":"Note - There is a small difference with some field names in the response between JSON and XML. When a field name has more than one word,…","schema":{"type":"string","enum":["json","xml"],"description":"Note - There is a small difference with some field names in the response between JSON and XML. When a field name has more than one word,…"}},{"name":"Authentication-Token","in":"query","required":false,"description":"The DigitalNZ API no longer requires a key to access public content. However, if you plan on using the API regularly, expect to be a high…","schema":{"type":"string","description":"The DigitalNZ API no longer requires a key to access public content. However, if you plan on using the API regularly, expect to be a high…"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated whitelist of fields to be returned. The syntax *\"&fields=verbose\"* can be used to return the bulk of the fields, or you…","schema":{"type":"string","description":"Comma-separated whitelist of fields to be returned. The syntax *\"&fields=verbose\"* can be used to return the bulk of the fields, or you…"}}],"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/open-data:digitalnz/get-records-record-id-more-like-this-format":{"get":{"operationId":"open_data_digitalnz_get_records_record_id_more_like_this_format","summary":"The \"More Like This\" call returns similar records to the specified ID.","description":"GET /records/{record_id}/more_like_this.{format}","tags":["open-data"],"parameters":[{"name":"record_id","in":"query","required":true,"description":"Every record has a unique, persistent *record_id*.","schema":{"type":"integer","description":"Every record has a unique, persistent *record_id*."},"example":35806021},{"name":"format","in":"query","required":true,"description":"Note - There is a small difference with some field names in the response between JSON and XML. When a field name has more than one word,…","schema":{"type":"string","enum":["json","xml"],"description":"Note - There is a small difference with some field names in the response between JSON and XML. When a field name has more than one word,…"}},{"name":"Authentication-Token","in":"query","required":false,"description":"The DigitalNZ API no longer requires a key to access public content. However, if you plan on using the API regularly, expect to be a high…","schema":{"type":"string","description":"The DigitalNZ API no longer requires a key to access public content. However, if you plan on using the API regularly, expect to be a high…"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated whitelist of fields to be returned. The syntax *\"&fields=verbose\"* can be used to return the bulk of the fields, or you…","schema":{"type":"string","description":"Comma-separated whitelist of fields to be returned. The syntax *\"&fields=verbose\"* can be used to return the bulk of the fields, or you…"}},{"name":"mlt_fields","in":"query","required":false,"description":"Comma-separated list of fields used to evaluate relatedness. Available fields to compare are *title* and *subject*, eg…","schema":{"type":"string","description":"Comma-separated list of fields used to evaluate relatedness. Available fields to compare are *title* and *subject*, eg…"}},{"name":"filtering","in":"query","required":false,"description":"More Like This (MLT) queries can be filtered in the same ways as regular searches, using the same syntax outined in the GET /records call…","schema":{"type":"string","description":"More Like This (MLT) queries can be filtered in the same ways as regular searches, using the same syntax outined in the GET /records call…"}}],"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"}}}}}}}