Difference between revisions of "Using the COPTR data feed"
Jump to navigation
Jump to search
Prwheatley (talk | contribs) (Created page with "Question: *I'd like to take the data in COPTR and create a funky 3D spinny view that helps people navigate the data and find what they are looking for. Can I do this, and can ...") |
|||
| Line 1: | Line 1: | ||
| + | = Accessing the COPTR data = | ||
| + | |||
Question: | Question: | ||
*I'd like to take the data in COPTR and create a funky 3D spinny view that helps people navigate the data and find what they are looking for. Can I do this, and can I host it somewhere else? | *I'd like to take the data in COPTR and create a funky 3D spinny view that helps people navigate the data and find what they are looking for. Can I do this, and can I host it somewhere else? | ||
| Line 4: | Line 6: | ||
Answer: | Answer: | ||
*Yes, that would be excellent! The COPTR content is made available under a CC-BY-SA license but we ask that if possible you point your users back to this site if they have corrections or new tools to add. | *Yes, that would be excellent! The COPTR content is made available under a CC-BY-SA license but we ask that if possible you point your users back to this site if they have corrections or new tools to add. | ||
| + | |||
| + | = Ways to access the COPTR data = | ||
| + | |||
| + | We offer two main channels for accessing the data - the MediaWiki API, and XML dumps of the MediaWiki content. | ||
| + | |||
| + | == The COPTR API == | ||
| + | As COPTR is based on MediaWiki, you can access the COPTR content via the MediaWiki API. The [https://www.mediawiki.org/wiki/API:Main_page Official MediaWiki API Documentation] is a pretty good starting point, and [http://wiki-dev.openplanetsfoundation.org/api.php the endpoint itself is _fairly_ self-documenting]. However, to get you started, here are some examples. | ||
| + | |||
| + | If you want access to information on what has changed recently, just like the [[Special:RecentChanges RecentChanges]] page, but in a machine-readable form, you can construct a URL like this: | ||
| + | |||
| + | http://wiki-dev.openplanetsfoundation.org/api.php?action=query&list=recentchanges&format=json&rclimit=500&rctype=new&rcprop=title%7Cids%7Csizes%7Cflags%7Cuser%7Ctimestamp | ||
| + | |||
| + | == The COPTR Database Backup Dumps == | ||
| + | We also make daily XML dumps available, for backup and re-use purposes. You can find them in the [http://wiki-dev.openplanetsfoundation.org/backup-dumps/ backup-dumps] folder, | ||
Revision as of 20:27, 12 November 2013
Accessing the COPTR data
Question:
- I'd like to take the data in COPTR and create a funky 3D spinny view that helps people navigate the data and find what they are looking for. Can I do this, and can I host it somewhere else?
Answer:
- Yes, that would be excellent! The COPTR content is made available under a CC-BY-SA license but we ask that if possible you point your users back to this site if they have corrections or new tools to add.
Ways to access the COPTR data
We offer two main channels for accessing the data - the MediaWiki API, and XML dumps of the MediaWiki content.
The COPTR API
As COPTR is based on MediaWiki, you can access the COPTR content via the MediaWiki API. The Official MediaWiki API Documentation is a pretty good starting point, and the endpoint itself is _fairly_ self-documenting. However, to get you started, here are some examples.
If you want access to information on what has changed recently, just like the Special:RecentChanges RecentChanges page, but in a machine-readable form, you can construct a URL like this:
The COPTR Database Backup Dumps
We also make daily XML dumps available, for backup and re-use purposes. You can find them in the backup-dumps folder,