Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jedahan/collections-api

API scraping from the metmuseum website
https://github.com/jedahan/collections-api

Last synced: 3 months ago
JSON representation

API scraping from the metmuseum website

Host: GitHub
URL: https://github.com/jedahan/collections-api
Owner: jedahan
Created: 2012-07-26T15:34:28.000Z (over 12 years ago)
Default Branch: master
Last Pushed: 2019-02-04T16:07:39.000Z (almost 6 years ago)
Last Synced: 2024-10-13T01:02:06.453Z (3 months ago)
Language: JavaScript
Homepage: http://scrAPI.org
Size: 476 KB
Stars: 36
Watchers: 20
Forks: 18
Open Issues: 6
Metadata Files:
- Readme: readme.md

Awesome Lists containing this project

README

# ⚠️ the museum api has changed a bunch, this needs a rewrite

# scrapi, a metropolitan museum collections api

[scrAPI.org](http://scrapi.org) is an api that grabs object information from the metropolitan museum's [collections](http://metmuseum.org/collection) website.

### Get a random object (`/random`)
Try `curl scrapi.org/random` in a terminal, or just click on [/random](random)
```bash
$ curl 'scrapi.org/random'
{
"CRDID": 12351,
"accessionNumber": "65.211.3",
...
}
```

### Object information (`/object/:id`)

Try `curl scrapi.org/object/123` in a terminal, or just click on [object/1234](object/123)
```bash
$ curl 'scrapi.org/object/123'
{
"CRDID": 123,
"accessionNumber": "64.291.2",
...
}
```

### Searching for object ids (`/search/:terms`)

You can now search for terms, and get back an array of hrefs to object pages
```bash
$ curl 'scrapi.org/search/mirror'
{
"collection": {
"items": [
{
"href": "http://scrapi.org/object/156225"
},
{
"href": "http://scrapi.org/object/207785"
},
...
]
}

}
```
### additional Params in search:

&page=X - for additional pages

&gallerynos=X for only objects in that gallery

### Filtering with the `fields` parameter

If you want to filter *any* response, use the `fields` parameter, like so:

```bash
$ curl 'scrapi.org/object/123?fields=title,whoList/who/name'
{
"whoList": {
"who": {
"name": "Richard Wittingham"
}
},
"title": "Andiron"
}
```

The syntax to filter out fields is loosely based on XPath:

- `a,b,c` comma-separated list will select multiple fields
- `a/b/c` path will select a field from its parent
- `a(b,c)` sub-selection will select many fields from a parent
- `a/*/c` the star `*` wildcard will select all items in a field

I like the following fields for basic object information: `fields=title,primaryArtistNameOnly,primaryImageUrl,medium,whatList/what/name,whenList/when/name,whereList/where/name,whoList/who/name`

### Guidelines

The code is [CC0](https://creativecommons.org/publicdomain/zero/1.0/), but if you do anything interesting with the data, it would be nice to give attribution to The Metropolitan Museum of Art. If you do anything interesting with the code, it would be nice to give attribution to the contributors, or even better, become one!

Please submit all questions, bugs and feature requests to [the issue page](https://github.com/jedahan/collections-api/issues).

Dedicated to the memory of [Aaron Swartz](https://en.wikipedia.org/wiki/Aaron_Swartz).

### Installation and Deployment

The API requires [node.js](https://nodejs.org/), uses [redis](http://redis.io/) for caching, and is built on the [koa](http://koajs.com/) web framework.

If you already have nodejs installed:

which yarn || npm install -g yarn
yarn
yarn start
open 127.0.0.1:8080 || xdg-open 127.0.0.1:8080

If you don't want to have to setup node, yarn, and redis on your local machine, I published a docker image:

which docker || { sudo apt-get install -y docker || cask install docker }
docker pull jedahan/collections-api
docker run -d -p 8080:8080 --name collections-api jedahan/collections-api
open 127.0.0.1:8080 || xdg-open 127.0.0.1:8080
curl localhost:8080/random

You can build the docker image yourself if you want:

which docker || { sudo apt-get install -y docker || cask install docker }
docker build -t jedahan/collections-api:latest .
docker run -d -p 8080:8080 --name collections-api jedahan/collections-api
open 127.0.0.1:8080 || xdg-open 127.0.0.1:8080
curl localhost:8080/random