Difference between revisions of "WebAPI/GetNewsForApp"
< WebAPI
(For some reason Valve decided to change "length" to "maxlength" between the time I made this page and now. Sorry about that.) |
m (Consistency edits and new/missed parameters.) |
||
Line 1: | Line 1: | ||
== URL == | == URL == | ||
− | <nowiki>http://api.steampowered.com/ISteamNews/GetNewsForApp/v0002</nowiki> | + | <nowiki>GET http://api.steampowered.com/ISteamNews/GetNewsForApp/v0002</nowiki> |
== Method-specific Parameters == | == Method-specific Parameters == | ||
− | ;appid: The game/item to retrieve news for. This can be any valid app ID as seen in the Steam store. | + | ;appid (uint32): The game/item to retrieve news for. This can be any valid app ID as seen in the Steam store. |
− | ; | + | ;{{API optional|maxlength}} (uint32): The max length of the '''contents''' field. |
− | ; | + | ;{{API optional|enddate}} (uint32): Unix timestamp, returns posts before this date. |
+ | ;{{API optional|count}} (uint32): The max number of news items to retrieve. Default: 20. | ||
+ | |||
+ | ;{{API optional|feeds}} (string): Commma-seperated list of feed names to return news for. | ||
== Result Data == | == Result Data == | ||
Revision as of 20:31, 5 February 2013
URL
GET http://api.steampowered.com/ISteamNews/GetNewsForApp/v0002
Method-specific Parameters
- appid (uint32)
- The game/item to retrieve news for. This can be any valid app ID as seen in the Steam store.
- maxlength (Optional) (uint32)
- The max length of the contents field.
- enddate (Optional) (uint32)
- Unix timestamp, returns posts before this date.
- count (Optional) (uint32)
- The max number of news items to retrieve. Default: 20.
- feeds (Optional) (string)
- Commma-seperated list of feed names to return news for.
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.
Languages: | English |