{"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/research:doaj/article-by-doi/{doi}":{"get":{"operationId":"research_doaj_article_by_doi","summary":"Article By Doi","description":"Find a DOAJ article by DOI.","tags":["research"],"parameters":[{"name":"doi","in":"path","required":true,"schema":{"type":"string"},"example":"10.3390/su12010001"}],"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":86400,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/research:doaj/article/{articleId}":{"get":{"operationId":"research_doaj_article","summary":"Article","description":"One DOAJ article by its DOAJ ID.","tags":["research"],"parameters":[{"name":"articleId","in":"path","required":true,"schema":{"type":"string"},"example":"0001a2b3c4d5e6f7a8b9c0d1e2f3a4b5"}],"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":86400,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/research:doaj/articles-by-journal":{"get":{"operationId":"research_doaj_articles_by_journal","summary":"Articles By Journal","description":"Articles published in the journal with this ISSN.","tags":["research"],"parameters":[{"name":"issn","in":"query","required":true,"schema":{"type":"string"},"example":"2071-1050"},{"name":"page","in":"query","required":false,"description":"1-based page number","schema":{"type":"integer","default":1,"minimum":1,"maximum":500,"description":"1-based page number"}},{"name":"limit","in":"query","required":false,"description":"Results per page","schema":{"type":"integer","default":10,"minimum":1,"maximum":100,"description":"Results per page"}}],"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":600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/research:doaj/harvest-articles":{"get":{"operationId":"research_doaj_harvest_articles","summary":"Harvest Articles","description":"Bulk-harvest article records via DOAJ's OAI-PMH endpoint.","tags":["research"],"parameters":[{"name":"verb","in":"query","required":false,"schema":{"type":"string","enum":["ListRecords","ListIdentifiers"],"default":"ListRecords"}},{"name":"metadataPrefix","in":"query","required":false,"schema":{"type":"string","enum":["oai_dc","oai_doaj"],"default":"oai_dc"}},{"name":"set","in":"query","required":false,"description":"OAI set spec (see harvest-sets)","schema":{"type":"string","description":"OAI set spec (see harvest-sets)"}},{"name":"from","in":"query","required":false,"description":"YYYY-MM-DD","schema":{"type":"string","description":"YYYY-MM-DD"}},{"name":"until","in":"query","required":false,"description":"YYYY-MM-DD","schema":{"type":"string","description":"YYYY-MM-DD"}},{"name":"cursor","in":"query","required":false,"description":"resumptionToken from a previous page","schema":{"type":"string","description":"resumptionToken from a previous page"}}],"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":600,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/research:doaj/harvest-journals":{"get":{"operationId":"research_doaj_harvest_journals","summary":"Harvest Journals","description":"Bulk-harvest journal records via DOAJ's OAI-PMH endpoint.","tags":["research"],"parameters":[{"name":"verb","in":"query","required":false,"schema":{"type":"string","enum":["ListRecords","ListIdentifiers"],"default":"ListRecords"}},{"name":"set","in":"query","required":false,"description":"OAI set spec (see harvest-sets)","schema":{"type":"string","description":"OAI set spec (see harvest-sets)"}},{"name":"from","in":"query","required":false,"description":"YYYY-MM-DD","schema":{"type":"string","description":"YYYY-MM-DD"}},{"name":"until","in":"query","required":false,"description":"YYYY-MM-DD","schema":{"type":"string","description":"YYYY-MM-DD"}},{"name":"cursor","in":"query","required":false,"description":"resumptionToken from a previous page","schema":{"type":"string","description":"resumptionToken from a previous page"}}],"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":600,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/research:doaj/harvest-sets":{"get":{"operationId":"research_doaj_harvest_sets","summary":"Harvest Sets","description":"List the OAI-PMH sets (subject classes) DOAJ exposes.","tags":["research"],"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":86400,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/research:doaj/journal-by-issn/{issn}":{"get":{"operationId":"research_doaj_journal_by_issn","summary":"Journal By Issn","description":"Find a DOAJ journal by print or electronic ISSN.","tags":["research"],"parameters":[{"name":"issn","in":"path","required":true,"schema":{"type":"string"},"example":"2071-1050"}],"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":86400,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/research:doaj/journal/{journalId}":{"get":{"operationId":"research_doaj_journal","summary":"Journal","description":"One DOAJ journal by its DOAJ ID.","tags":["research"],"parameters":[{"name":"journalId","in":"path","required":true,"schema":{"type":"string"},"example":"f3f2e7f23d444370ae5f5199f85bc100"}],"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":86400,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/research:doaj/journals-by-country":{"get":{"operationId":"research_doaj_journals_by_country","summary":"Journals By Country","description":"Journals whose publisher is in a country (ISO 3166-1 alpha-2 code).","tags":["research"],"parameters":[{"name":"country","in":"query","required":true,"schema":{"type":"string"},"example":"ID"},{"name":"page","in":"query","required":false,"description":"1-based page number","schema":{"type":"integer","default":1,"minimum":1,"maximum":500,"description":"1-based page number"}},{"name":"limit","in":"query","required":false,"description":"Results per page","schema":{"type":"integer","default":10,"minimum":1,"maximum":100,"description":"Results per page"}}],"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":600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/research:doaj/journals-by-publisher":{"get":{"operationId":"research_doaj_journals_by_publisher","summary":"Journals By Publisher","description":"Journals from a publisher name.","tags":["research"],"parameters":[{"name":"publisher","in":"query","required":true,"schema":{"type":"string"},"example":"MDPI"},{"name":"page","in":"query","required":false,"description":"1-based page number","schema":{"type":"integer","default":1,"minimum":1,"maximum":500,"description":"1-based page number"}},{"name":"limit","in":"query","required":false,"description":"Results per page","schema":{"type":"integer","default":10,"minimum":1,"maximum":100,"description":"Results per page"}}],"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":600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/research:doaj/journals-by-subject":{"get":{"operationId":"research_doaj_journals_by_subject","summary":"Journals By Subject","description":"Journals classified under a subject term.","tags":["research"],"parameters":[{"name":"subject","in":"query","required":true,"schema":{"type":"string"},"example":"Medicine"},{"name":"page","in":"query","required":false,"description":"1-based page number","schema":{"type":"integer","default":1,"minimum":1,"maximum":500,"description":"1-based page number"}},{"name":"limit","in":"query","required":false,"description":"Results per page","schema":{"type":"integer","default":10,"minimum":1,"maximum":100,"description":"Results per page"}}],"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":600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/research:doaj/search-articles":{"get":{"operationId":"research_doaj_search_articles","summary":"Search Articles","description":"Search DOAJ articles (Elasticsearch query-string syntax).","tags":["research"],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":"climate change"},{"name":"page","in":"query","required":false,"description":"1-based page number","schema":{"type":"integer","default":1,"minimum":1,"maximum":500,"description":"1-based page number"}},{"name":"limit","in":"query","required":false,"description":"Results per page","schema":{"type":"integer","default":10,"minimum":1,"maximum":100,"description":"Results per page"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["relevance","createdAt","updatedAt","title","year"],"default":"relevance"}},{"name":"order","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"desc"}}],"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":600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/research:doaj/search-journals":{"get":{"operationId":"research_doaj_search_journals","summary":"Search Journals","description":"Search DOAJ journals.","tags":["research"],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":"public health"},{"name":"page","in":"query","required":false,"description":"1-based page number","schema":{"type":"integer","default":1,"minimum":1,"maximum":500,"description":"1-based page number"}},{"name":"limit","in":"query","required":false,"description":"Results per page","schema":{"type":"integer","default":10,"minimum":1,"maximum":100,"description":"Results per page"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["relevance","createdAt","updatedAt","title"],"default":"relevance"}},{"name":"order","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"desc"}}],"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":600,"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"}}}}}}}