https://github.com/impossibilitylabs/artsy
Stateful REST API wrapper for Artsy https://www.artsy.net/
https://github.com/impossibilitylabs/artsy
artsy elixir elixir-library rest-api
Last synced: 2 days ago
JSON representation
Stateful REST API wrapper for Artsy https://www.artsy.net/
- Host: GitHub
- URL: https://github.com/impossibilitylabs/artsy
- Owner: ImpossibilityLabs
- License: mit
- Created: 2017-03-11T16:15:25.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-18T12:45:58.000Z (over 9 years ago)
- Last Synced: 2025-10-21T15:56:23.747Z (8 months ago)
- Topics: artsy, elixir, elixir-library, rest-api
- Language: Elixir
- Homepage:
- Size: 7.81 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Artsy
Stateful REST API wrapper for [Artsy](https://developers.artsy.net/docs/artworks). It automatically generates JWT token to access API and keeps it updated.
## Installation
The package can be installed by adding `artsy` to your list of dependencies and applications in `mix.exs`:
```elixir
def deps do
[{:artsy, "~> 0.1"}]
end
def application do
[extra_applications: [:artsy]]
end
```
### Config
Put API credentials for your Artsy application.
```
config :artsy, Artsy,
url: "https://api.artsy.net/api",
client_id: "******",
client_secret: "*********"
```
## Usage
### Artworks
Calls of `Artsy.artworks()` will paginate through a listed artworks, use `Artsy.artworks(:reset)` to reset pagination cursor back to the first page.
### Artists
Calls of `Artsy.artists()` will paginate through a listed artists, use `Artsy.artists(:reset)` to reset pagination cursor back to the first page.
In case you need to get artist for a specific artwork use: `Artsy.artists(:artwork, artwork_id)`.
## Diclaimer
**This library is in it's early beta and lack most of features.**