<!--
{
  "availability" : [

  ],
  "documentType" : "symbol",
  "framework" : "AppleNews",
  "identifier" : "/documentation/AppleNewsAPI",
  "metadataVersion" : "0.1.0",
  "role" : "Web Service",
  "symbol" : {
    "kind" : "Web Service",
    "modules" : [
      "Apple News API"
    ],
    "preciseIdentifier" : "AppleNewsAPI"
  },
  "title" : "Apple News API"
}
-->

# Apple News API

Publish and manage Apple News Format articles.

## Overview

The Apple News API delivers Apple News Format articles to be published in the Apple News app and helps you manage and monitor those articles after they’ve been published.

Based on representational state transfer (REST) technology, the Apple News API has typical RESTful characteristics, which means that it:

- Does operations on a set of resources. Resources are objects that have a type, associated data, and relationships to other resources. In the Apple News API, resources include channels, sections that you’ve set up for your channels (for example, Sports or Politics), and the articles that you want to publish and manage.
- Has stateless operations. Interactions with the create, read, update, and delete (CRUD) operations are handled using only the information that comes with the request — no previous information or state is assumed. Therefore, requests made using the Apple News API must include all information required to complete the operation within the request.

## Topics

### Essentials

  <doc://com.apple.applenews/documentation/AppleNews/getting-ready-to-publish-and-manage-your-articles>

  <doc://com.apple.applenews/documentation/AppleNews/about-the-apple-news-security-model>

  <doc://com.apple.applenews/documentation/AppleNews/about-apple-news-api-field-types>

  <doc://com.apple.applenews/documentation/AppleNews/formatting-strings>

### Release Notes

Release notes announce new features, updates, and deprecations for major releases, so you can plan for changes and make adjustments as needed.

  <doc://com.apple.applenews/documentation/AppleNews/apple-news-api-release-notes>

### Channel

[`Read Channel Information`](/documentation/AppleNewsAPI/GET-channels-_channelId_)

Get details about your channel, including the name, corresponding website, and default section.

[`Read Channel Quota Information`](/documentation/AppleNewsAPI/GET-channels-_channelId_-quota)

Get details about your channel’s remaining quota for sending create and update requests, the queue size, and wait time.

[`Channel`](/documentation/AppleNewsAPI/Channel)

See the fields the read channel endpoint returned.

[`ChannelLinks`](/documentation/AppleNewsAPI/ChannelLinks)

See the links the read channel endpoint returned.

[`ChannelResponse`](/documentation/AppleNewsAPI/ChannelResponse)

See which objects make up the channel response.

### Sections

[`List All Sections`](/documentation/AppleNewsAPI/GET-channels-_channelId_-sections)

See a list of available sections in your channel.

[`Read Section Information`](/documentation/AppleNewsAPI/GET-sections-_sectionId_)

Get information about the specified section, including its name, its channel, and whether it’s a default section.

[`Promote Articles in a Section`](/documentation/AppleNewsAPI/POST-sections-_sectionId_-promotedArticles)

Set the list of promoted articles for the specified section.

[`Section`](/documentation/AppleNewsAPI/Section)

See the fields the section endpoints returned.

[`SectionLinks`](/documentation/AppleNewsAPI/SectionLinks)

See the links the section endpoints returned.

[`SectionResponse`](/documentation/AppleNewsAPI/SectionResponse)

See which objects make up the section response.

[`PromoteArticleRequest`](/documentation/AppleNewsAPI/PromoteArticleRequest)

See the required field for the Promote an Article request.

[`PromoteArticleResponse`](/documentation/AppleNewsAPI/PromoteArticleResponse)

See the field the Promote an Article response returned.

### Articles

[`Create an Article`](/documentation/AppleNewsAPI/POST-channels-_channelId_-articles)

Publish an article to your channel.

[`Read Article Information`](/documentation/AppleNewsAPI/GET-articles-_articleId_)

Retrieve information about an article, such as the revision number and maturity rating.

[`Search Articles in a Channel`](/documentation/AppleNewsAPI/GET-channels-_channelId_-articles)

See a list of all articles in a channel that match the specified search criteria.

[`Search Articles in a Section`](/documentation/AppleNewsAPI/GET-sections-_sectionId_-articles)

See a list of all articles in a section that match the specified search criteria.

[`Update an Article`](/documentation/AppleNewsAPI/POST-articles-_articleId_)

Update an existing article in your channel.

[`Delete an Article`](/documentation/AppleNewsAPI/DELETE-articles-_articleId_)

Delete the specified article from your channel.

[`Create Article Metadata Fields`](/documentation/AppleNewsAPI/Create-Article-Metadata-Fields)

See the optional metadata fields for the Create an Article Request.

[`ArticleLinksRequest`](/documentation/AppleNewsAPI/ArticleLinksRequest)

See the required field for the Create an Article request.

[`Update Article Metadata Fields`](/documentation/AppleNewsAPI/Update-Article-Metadata-Fields)

See the metadata fields for the Update an Article request.

[`Article`](/documentation/AppleNewsAPI/Article)

See the fields the article endpoints returned.

[`ArticleResponse`](/documentation/AppleNewsAPI/ArticleResponse)

See which objects make up the Create an Article, Read an Article, and Update an Article responses.

[`ArticleLinksResponse`](/documentation/AppleNewsAPI/ArticleLinksResponse)

See the links the article endpoints returned.

[`SearchResponse`](/documentation/AppleNewsAPI/SearchResponse)

See the fields the search article endpoints returned.

[`Meta`](/documentation/AppleNewsAPI/Meta)

See the object that wraps the throttling information that’s returned for the Create an Article and Read an Article endpoints.

[`Throttling`](/documentation/AppleNewsAPI/Throttling)

See the object that wraps the throttling information that’s returned for the Create an Article and Update an Article endpoints.

### Errors

  <doc://com.apple.applenews/documentation/AppleNews/about-apple-news-api-error-messages>

[`Warning`](/documentation/AppleNewsAPI/Warning)

See the properties of a warning the Apple News API returned.

[`Error`](/documentation/AppleNewsAPI/Error)

See the properties of an error the Apple News API returned.

[`Code`](/documentation/AppleNewsAPI/Code)

See the error codes the Apple News API returned.

[`Status`](/documentation/AppleNewsAPI/Status)

See the HTTP status codes the Apple News API returned.



---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)