https://github.com/dinubs/jam-api

Parse web pages using CSS query selectors
https://github.com/dinubs/jam-api

api css javascript json nodejs

Last synced: 14 days ago
JSON representation

Parse web pages using CSS query selectors

• Host: GitHub
• URL: https://github.com/dinubs/jam-api
• Owner: dinubs
• License: other
• Created: 2016-01-21T00:57:10.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2019-05-13T17:03:36.000Z (over 5 years ago)
• Last Synced: 2024-10-23T01:37:51.780Z (21 days ago)
• Topics: api, css, javascript, json, nodejs
• Language: HTML
• Homepage: http://www.jamapi.xyz
• Size: 5.11 MB
• Stars: 1,368
• Watchers: 33
• Forks: 61
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
**This project is no longer active developement, please see [CoolQLCool](https://www.github.com/dinubs/coolqlcool) for a similar more active project ([ref](https://github.com/dinubs/jam-api/issues/24))**

# Jam API

Jam API is a service that allows you to turn any site into a JSON accessible api using CSS selectors. To get started simply run a post request to https://www.jamapi.xyz with formdata of "url" and "json_data", here's an example of what your data should look like:

```json

{

  "title": "title",

  "logo": ".nav-logo img",

  "paragraphs": [{ "elem": ".home-post h1", "value": "text"}],

  "links": [{"elem": ".home-post > a:first-of-type", "location": "href"}]

}

```

Using API you can simply generate JSON data from any website.

## Code samples

### nodejs

```js

const request = require('request');

request.post('https://www.jamapi.xyz/', {form: {url: 'http://www.gavin.codes/', json_data: '{"title": "title"}'}}, function(err, response, body) {

  console.log(body);

})  

```

### Javascript

```js

fetch('https://www.jamapi.xyz', {

    method: 'POST',

    headers: {

      'Accept': 'application/json',

      'Content-Type': 'application/json'

    },

    body: JSON.stringify({

      url: 'http://www.gavin.codes/',

      json_data: '{"title": "title"}'

    })

  }).then(function(response) {

    return response.json();

  }).then(function(json) {

    document.body.innerHTML = json;

  });  

```

### Ruby

```ruby

require 'httparty'

response = HTTParty.post("https://www.jamapi.xyz/",

  :body => { "url" => "http://www.gavin.codes/", "json_data" => "{'title': 'title'}"})  

puts response.to_json

```

### Python

```python

import requests

payload = {'url': 'http://www.gavin.codes/', 'json_data': '{"title": "title"}'}

r = requests.post("https://www.jamapi.xyz", data=payload)

print(r.json())

```

### curl

```shell

curl -X POST \

  -F 'url=http://www.gavin.codes/' \

  -F 'json_data={"title":"title"}' \

  https://www.jamapi.xyz

```

## Features

Will auto pull the img src on corresponding elements, will auto pull the href from links. If passing JSON, you must provide a "elem" property, and then the element attributes you want. When you pass an array with JSON you'll get a structure that looks as follows:

```json

[

  {

      "index": 0,

      "value": {

          "value": "Porter Robinson – Sad Machine (Cosmo’s Midnight Remix)"

      }

  },

  {

      "index": 1,

      "value": {

          "value": "Listen to Rachel Platten’s “Stand By You”"

      }

  }]

```

All the attributes you provide as JSON will be put inside of the value property, and the index property is to be able to track what index it ocurred in the DOM. I nested JSON values into it's own so that you can still have an "index" property returned and not run into issues.

## How it works

Main power of the program is in `services/html_to_json.js`. Start site with `node index` after doing `npm install`.

Suggested node version is at least `4.2.2`