# DOAJ Journal

## Overview

| Property | Value |
|----------|-------|
| **Status** | active |
| **Method** | `GET` |
| **Endpoint** | `/v2/doaj/journal` |
| **Base URL** | `https://api.piloterr.com` |
| **Credit Cost** | 1 credit per call |
| **Documentation** | https://www.piloterr.com/library/doaj-journal |

## Description

Fetch one DOAJ journal by ISSN, journal id, or a doaj.org toc URL.

## Authentication

- **Key Name:** `x-api-key`
- **Location:** HTTP Header
- **Get an API key:** https://app.piloterr.com/register

## Example Request

```bash
curl --location --request GET 'https://api.piloterr.com/v2/doaj/journal' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Example Response

### CERiMRE

```json
{
  "id": "00087d1be705481c92efc11a6dc42b80",
  "url": "https://doaj.org/toc/2747-173X",
  "eissn": "2747-173X",
  "pissn": null,
  "title": "Computational and Experimental Research in Materials and Renewable Energy",
  "has_apc": false,
  "license": "CC BY-SA",
  "keywords": [
    "renewable energy",
    "nuclear materials",
    "thermoelectric materials",
    "ptoelectronics materials"
  ],
  "oa_start": "2018",
  "subjects": [
    "Renewable energy sources"
  ],
  "languages": [
    "EN"
  ],
  "publisher": "Physics Department, Faculty of Mathematics and Natural Sciences University of Jember",
  "license_url": "https://creativecommons.org/licenses/by-sa/4.0/",
  "alternative_title": "CERiMRE",
  "publisher_country": "ID"
}
```

## Documentation

## Overview
Fetch one DOAJ journal. `query` is an ISSN from search, such as `2747-173X`, the 32-character journal id, or a URL `https://doaj.org/toc/{issn}`. The response is a flat object. `eissn` or `pissn` on a journal search card is the usual key.

## Quickstart
```
curl -sS -H "x-api-key: YOUR_API_KEY" "https://api.piloterr.com/v2/doaj/journal?query=2747-173X"
curl -sS -H "x-api-key: YOUR_API_KEY" "https://api.piloterr.com/v2/doaj/journal?query=https%3A%2F%2Fdoaj.org%2Ftoc%2F2747-173X"
```

## Parameters
| Name | Detail |
|---|---|
| query | Required string. ISSN, journal id, or a doaj.org/toc URL. Example: `2747-173X`. |

## Response fields
| Name | Detail |
|---|---|
| id | String. DOAJ journal id. |
| title | String. |
| alternative_title | String or null. |
| eissn | String or null. |
| pissn | String or null. |
| publisher | String or null. |
| publisher_country | String or null. ISO country code when DOAJ sends one. |
| languages | Array of strings. |
| subjects | Array of strings. |
| keywords | Array of strings. |
| license | String or null. |
| license_url | String or null. |
| has_apc | Boolean or null. True when the journal charges an article processing charge. |
| oa_start | String or null. Year open access started. |
| url | String. `https://doaj.org/toc/{issn}` when an ISSN exists. |

## Pagination
One journal. No `pagination` object.

## Use cases
- A library checks that ISSN `2747-173X` is indexed and reads `license`.
- An APC tracker stores `has_apc` before recommending a journal found with `kind=journal`.
- A catalog import copies `publisher`, `publisher_country`, and `subjects` for an ISSN taken from search.

## Error codes
| Name | Detail |
|---|---|
| 400 | Missing `query`, a non-DOAJ host, or a URL that is not a toc or journal path. |
| 404 | Unknown ISSN or journal id. |
| 401 | Missing API key. |
| 500 | The DOAJ request failed. |

## Related endpoints
- [DOAJ Search](https://www.piloterr.com/library/doaj-search)