Difference between revisions of "WebAPI/GetNewsForApp"

From Team Fortress Wiki
Jump to: navigation, search
(Notes)
(Method-specific Parameters)
Line 7: Line 7:
 
;count: The max number of news items to retrieve.
 
;count: The max number of news items to retrieve.
  
;length: The max length of the '''contents''' field.<ref>As of 9/02/2012, setting the length parameter did not limit the max length of the '''contents''' field.</ref>
+
;length: The max length of the '''contents''' field.<ref>Currently, setting the length parameter does not limit the max length of the '''contents''' field. (Noted on 9/01/2012)</ref>
  
 
== Result Data ==
 
== Result Data ==

Revision as of 06:32, 3 September 2012

URL

http://api.steampowered.com/ISteamNews/GetNewsForApp/v0002

Method-specific Parameters

appid
The game/item to retrieve news for. This can be any valid app ID as seen in the Steam store.
count
The max number of news items to retrieve.
length
The max length of the contents field.[1]

Result Data

appnews
appid
The appid of the item news is fetched for.
newsitems
A list of objects describing each news item.
gid
The unique identifier of the news item.
title
Title of the news item.
url
Permanent link to the item
is_external_url
true if the url given links to an external website. false if it links to the Steam store.
author
The author of the news item.
contents
The article body with a length equal to the given length with an appended ellipsis if it is exceeded.
feedlabel
The category label of the news item.
date
A unix timestamp of the date the item was posted.
feedname
An internal tag that describes the source of the news item.

Notes

  1. Currently, setting the length parameter does not limit the max length of the contents field. (Noted on 9/01/2012)