# DOAJ Article

## Overview

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

## Description

Fetch one DOAJ article by its id or by a doaj.org article 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/article' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Example Response

### herring article

```json
{
  "id": "000004687a3a411cb466625281f2ceb0",
  "doi": "10.1002/ece3.8411",
  "url": "https://doaj.org/article/000004687a3a411cb466625281f2ceb0",
  "year": "2021",
  "issue": "24",
  "month": "12",
  "title": "Fishing, predation, and temperature drive herring decline in a large marine ecosystem",
  "volume": "11",
  "authors": [
    {
      "name": "Daniel G. Boyce",
      "affiliation": "Ocean Sciences Division Bedford Institute of Oceanography Dartmouth NS Canada"
    },
    {
      "name": "Brian Petrie",
      "affiliation": "Ocean Sciences Division Bedford Institute of Oceanography Dartmouth NS Canada"
    },
    {
      "name": "Kenneth T. Frank",
      "affiliation": "Ocean Sciences Division Bedford Institute of Oceanography Dartmouth NS Canada"
    }
  ],
  "abstract": "Abstract Since 1960, landings of Atlantic herring have been the greatest of any marine species in Canada, surpassing Atlantic cod and accounting for 24% of the total seafood harvested in Atlantic Canada. The Scotian Shelf‐Bay of Fundy herring fisheries (NAFO Division 4VWX) is among Canada's oldest and drives this productivity, accounting for up to 75% of the total herring catch in some years. The stocks’ productivity and overall health have declined since 1965. Despite management measures to promote recovery implemented since 2003, biomass remains low and is declining. The factors that drive the productivity of 4VWX herring are primarily unresolved, likely impeding the effectiveness of management actions on this stock.",
  "end_page": null,
  "keywords": [
    "Atlantic herring",
    "climate change",
    "ecosystem",
    "ecosystem‐based",
    "egg predation",
    "exploitation"
  ],
  "subjects": [
    "Ecology"
  ],
  "start_page": null,
  "fulltext_url": "https://doi.org/10.1002/ece3.8411",
  "journal_issn": null,
  "journal_title": "Ecology and Evolution"
}
```

## Documentation

## Overview
Fetch one DOAJ article. `query` is the article id from search, for example `000004687a3a411cb466625281f2ceb0`, or `https://doaj.org/article/{id}`. The response is a flat object.

Some fields that appear on the search card, such as page numbers, can be null on this record when DOAJ omits them from the article payload.

## Quickstart
```
curl -sS -H "x-api-key: YOUR_API_KEY" "https://api.piloterr.com/v2/doaj/article?query=000004687a3a411cb466625281f2ceb0"
curl -sS -H "x-api-key: YOUR_API_KEY" "https://api.piloterr.com/v2/doaj/article?query=https%3A%2F%2Fdoaj.org%2Farticle%2F000004687a3a411cb466625281f2ceb0"
```

## Parameters
| Name | Detail |
|---|---|
| query | Required string. Article id or a doaj.org/article URL. Example: `000004687a3a411cb466625281f2ceb0`. |

## Response fields
| Name | Detail |
|---|---|
| id | String. Same id as the search card. |
| title | String. |
| abstract | String or null. |
| year | String or null. |
| month | String or null. |
| authors | Array of `{name, affiliation}`. |
| keywords | Array of strings. |
| subjects | Array of strings. |
| journal_title | String or null. |
| journal_issn | String or null. Use it with the journal endpoint when it is present. |
| volume | String or null. |
| issue | String or null. |
| start_page | String or null. |
| end_page | String or null. |
| doi | String or null. |
| fulltext_url | String or null. |
| url | String. `https://doaj.org/article/{id}`. |

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

## Use cases
- A repository takes the id from a climate search and stores `doi`, `authors`, and `fulltext_url`.
- A reference manager accepts a `doaj.org/article` URL pasted by a researcher.
- A review database keeps `year`, `volume`, and `journal_title` for each screened paper.

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

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