❤
npm
Sign UpSign In

particle-api

0.0.1 • Public • Published

Particle API

An API to store & retrieve reusable bits of content as data. Also used to store handlebars templates that can render those bits of content in various ways, and endpoints to do the actual rendering. Also used to store dehydrated article data, and associate them with particles that's been embedded in them.

Authors

Requirements

  1. Docker
  2. Docker Compose
  3. Node.js 7.2.1
  4. Yarn 0.17.8
  5. Gulp 3.9.1
  6. Ruby

⚠️

Something helpful for you developers:

  1. curl -o- -L https://yarnpkg.com/install.sh
  2. yarn global add gulp
  3. Install Xcode command line tools (INSTEAD OF RUBY if you dont have it)

General

Quick Start

Build & Run

Build and start the whole service is simple as: make build && make run. That command run all related services and mimic the production environment setup on your local machine.

Stop

make stop stop all service containers that have been started by either make up or make run anytime you feel you need a coffee/break.

Start Service standalone

To run the API on your machine, you can run a couple of make targets:

  • make deps - Install project dependancies, generally not required if you're using docker. (run whenever you change node modules)
  • make build - Builds docker image.
  • make run - Runs the particle API in a docker container.

Links

API URL

http://localhost:5000

Particle CMS URL

requires running the particle CMS, see it's own README for info.

http://localhost:3000

Local S3 Browser URL

requires running the particle CMS, see it's own README for info.

http://localhost:9000

Old CMS URL

requires running the particle CMS, see it's own README for info.

http://localhost:9000

Misc

There are few other useful make targets that you can preview by calling make help or just make both in the root directory.

What are Particles?

The term Particle is inspired by the following NYT piece, which, at the time it was published, was perfectly aligned with our thinking around the problem of publication of content for mass consumption.

Particles are components that Articles are made of. It suggests a graph-based approach to publishing, rather than the traditional document-based approach, whereby every Article becomes a series of particles connected by a graph, rather than a single document.

Particles are reusable across multiple Articles, and they have a lifecycle of their own, beyond the context of an Article in which they happen to appear.

We used to call them Embeds.

What is the Particle API?

The Particle API is an interface to the data store where our particles are stored. It allows thin front ends to be built to consume, create, and manage Particles. The Particle CMS is an example of such a front end.

Authentication

The API’s readable endpoints (or any endpoints that doesn’t result in a change being made to the data store) are completely open, and can be queried from anywhere in the world.

The writable endpoints, however, are protected by the following two schemes:

Google user id token

This method of authentication is meant for client where a user is involved, and involves the following steps:

  • Implementing Google sign-in for web
  • Getting an id_token from Google after the user has signed in (also described at the above link)
  • Sending the query variable ?id_token=your-users-id-token with every writable query

Payload signature

This method of authentication is meant for back end clients, where no user is involved, and involves the following procedure:

  • Build a string by concatenating the Google Client Secret, Google Client ID, the request path (without query string), the request method in uppercase letters, and the payload. The resulting string will look something like this: cL13NtS3cr3TcL13Nt1D/templatesPOST{"my":"payload","is":"here"}
  • Calculate the sha256 digest of this string, using any standard crypto library.
  • Sending the query variable ?sig=your-calculated-digest with every writable query

The Google Client ID and Google Client Secret for each environment can be requested from the Editorial Innovation team.

Item store

/lib/itemStore.js The Itemstore is the framework that underlies the particle store, the template store, the article store, and all other future and legacy stores that might be added.

Querying items

  • endpoint: GET /itemType-plural
  • query variables:
    • count: the maximum amount of items to return
    • before: timestamp (epoch milliseconds) of earliest item’s last_modified_date (this is an inclusive query)
    • after: timestamp (epoch milliseconds) of last item’s last_modified_date (this is an inclusive query)
    • key: filter on any exact match of item attribute (top level only, ie shallow)
  • return value: List of Items, each with the following structure of auto-generated attributes:
{
    "author": {
        "email": "author_email",
        "name": "author_full_name",
        "given_name": "author_given_name",
        "family_name": "author_family_name"
    },
    "last_modified_date": in_milliseconds_since_epoch,
    "publication_date": in_milliseconds_since_epoch,
    "id": "item_id",
    ... // custom item attributes
}

EXAMPLES:

http://particle-api-staging.eip.telegraph.co.uk/itemType-plural (returns 100 particles by default)

http://particle-api-staging.eip.telegraph.co.uk/itemType-plural?count=5 (returns only 5)

http://particle-api-staging.eip.telegraph.co.uk/itemType-plural?count=5&before=1449662938252 (returns the latest 5 particles before and including Wed Dec 09 2015 12:08:58)

http://particle-api-staging.eip.telegraph.co.uk/itemType-plural?count=5&after=1449662938252 (returns the latest 5 particles after and including Wed Dec 09 2015 12:08:58)

http://particle-api-staging.eip.telegraph.co.uk/itemType-plural?key1=value1&key2=value2 (returns all particles where attribute key1 is value1 and key2 is value2)

Querying a single item

  • endpoint: GET /itemType-plural/:itemId
  • return value: A single Item, with the following structure:
{
    "author": {
        "email": "author_email",
        "name": "author_full_name",
        "given_name": "author_given_name",
        "family_name": "author_family_name"
    },
    "last_modified_date": in_milliseconds_since_epoch,
    "publication_date": in_milliseconds_since_epoch,
    "id": "item_id",
    ... // custom item attributes
}

Creating items

  • endpoint: POST /itemType-plural
  • query variables:
    • id_token: (see authentication)
    • sig: (see authentication)
  • body: Serialised JSON:
{
    // ... custom item attributes
}

NOTE:

author, last_modified_date, publication_date, and id are automatically created - but author can also be supplied with a POST or PUT request. The other automatically create attributes (last_modified_date, publication_date, and id) will be overwritten if supplied

  • return value:
{
    "id": "id_of_created_item",
    "redis": { redis_store_result },
    "redisList-A": { redis_list_store_result },
    "redisList-B": { redis_list_store_result },
    // ... more redisList results
    "s3": { s3_store_result }
}

Updating items

  • endpoint: PUT /itemType-plural/:itemId
  • query variables:
    • id_token: (see authentication)
    • sig: (see authentication)
  • body: Serialised JSON:
{
    // ... custom item attributes
}
  • return value:
{
    "redis": { redis_update_result },
    "redisList-A": { redis_list_store_result },
    "redisList-B": { redis_list_store_result },
    // ... more redisList results
    "s3": { s3_update_result }
}

Deleting items

  • endpoint: DELETE /itemType-plural/:itemId
  • query variables:
    • id_token: (see authentication)
    • sig: (see authentication)
  • return value:
{
    "redis": { redis_delete_result },
    "redisList-A": { redis_list_delete_result },
    "redisList-B": { redis_list_delete_result },
    // ... more redisList results
    "s3": { s3_delete_result }
}

Item types

Particles

Particles contain metadata in the top level attributes of the particle object, and content data in a data attribute. The entire particle object, when compiled with a template, produces a rendition of the content.

Auto-generated

Particles have two custom auto-generated attributes:

  • tokens: (string) Facilitates the keyword-based searching of particles; composed by taking the first 50 words found in the particle that is shorter than or equal to 20 characters long (these are determined by two variables, maxWords and longestWord, in /lib/tokenize.js)
  • uris: (object) A list of URI's. There will always be a data attribute, pointing to the particle's data representation. For each template that matches the particle type and version, there will also be url for the rendition, as the context attribute of the particle. If, however, the template has a subcontext attribute, the URI of that template's rendition will be populated as the subcontext-context attributes of the uris object. (this logic is contained in the addUris function in /lib/itemStore.js)

Custom

Particles have, by convention, the following custom attributes:

  • type: (string) This, together with version, is used to match particles to templates
  • version: (string) This, together with type, is used to match particles to templates
  • static: (boolean) Static particles are not embedded in iframes. This breaks the reusability and portability function of particles, and should be removed in future. The only static particle type is pull-quote
  • section: (string) Not used anymore, and should always be empty
  • title: (string) The particle title, representing the particle in listings
  • notes: (string) Notes to editors, for instance when a particle has an embargo date, before which it should not be used

Querying particles

  • endpoint: GET /particles
  • query variables: all of the item store query variables, plus:
    • query: freeform text search that matches words in the tokens attribute. This is an intersection (AND) query, in other words, all words in the query has to be found in the tokens attribute for a particle to be returned.
  • return value: List of Particles, each with the following structure:
{
    // ... all item store attributes, plus
    "type": "particle_type",
    "version": "particle_version",
    "static": "only-true-for-pull-quotes-otherwise-false",
    "section": "",
    "title": "particle_title",
    "notes": "notes_to_editors",
    "tokens": "the-first-50-words-shorter-than-21-chars-found-in-particle",
    "uris": {
        "data": "particle-data-uri",
        "context": "particle-rendition-by-template-context",
        "subcontext-context": "particle-rendition-by-template-context-and-subcontext"
        // more contexts/subcontexts
    }
}

EXAMPLES UNIQUE TO PARTICLES:

http://particle-api-staging.eip.telegraph.co.uk/particles?query=government+elections (returns all particles that, somewhere in data, contains "government elections")

http://particle-api-staging.eip.telegraph.co.uk/particles?type=puff (returns all particles where attribute "type" is "puff")

http://particle-api-staging.eip.telegraph.co.uk/particles?type=puff&version=0.0.1 (returns all particles where attribute "type" is "puff" and "version" is "0.0.1")

Querying a single particle

  • endpoint: GET /particles/:particleId
  • return value: A single Particles, with the following structure:
{
    // ... all item store attributes, plus
    "type": "particle_type",
    "version": "particle_version",
    "static": "only-true-for-pull-quotes-otherwise-false",
    "section": "",
    "title": "particle_title",
    "notes": "notes_to_editors",
    "tokens": "the-first-50-words-shorter-than-21-chars-found-in-particle",
    "data": { particle-custom-data },
    "uris": {
        "data": "particle-data-uri",
        "context": "particle-rendition-by-template-context",
        "subcontext-context": "particle-rendition-by-template-context-and-subcontext"
        // more contexts/subcontexts
    }
}

NOTE:

The data attribute is only exposed on the single particle endpoint

Creating particles

  • endpoint: POST /particles
  • query variables: as for item store
  • body: Serialised JSON:
{
    "type": "particle_type",
    "version": "particle_version",
    "static": "only-true-for-pull-quotes-otherwise-false",
    "section": "",
    "title": "particle_title",
    "notes": "notes_to_editors",
    "data": { particle-custom-data }
}

NOTE:

author, last_modified_date, publication_date, tokens, id and uris are automatically created

  • return value: as for item store

Updating particles

  • endpoint: PUT /particles/:particleId
  • query variables: as for item store
  • body: Serialised JSON:
{
    "type": "particle_type",
    "version": "particle_version",
    "section": "",
    "title": "particle_title",
    "notes": "notes_to_editors",
    "data": { particle-custom-data }
}
  • return value: as for item store

Deleting particles

  • endpoint: DELETE /particles/:particleId
  • query variables: as for item store
  • return value: as for item store

Templates

  • Templates in this context refers to handlebars templates, which are used to compile each particle out to a number of output formats (also called contexts). html is a common context. cms is another, which defines a particles edit or "create" interface in the Particle CMS. When more than one template of the same context is needed (for instance, when an alternative html view is needed), the subcontext attribute is used to distinguish between them.

Custom

Templates have, by convention, the following custom attributes:

  • type: (string) This, together with version, is used to match particles to templates
  • version: (string) This, together with type, is used to match particles to templates
  • context: (string) Determines the output context of the template (for instance html)
  • subcontext: (string) Optional. Provides the ability to render more than one rendition for the same context (for instance, different html renditions)
  • template: (string) The actual template.

Querying templates

  • endpoint: GET /templates
  • query variables: as for item store
  • return value: List of Templates, each with the following structure:
{
    // ... all item store attributes, plus
    "type": "template_type",
    "version": "template_version",
    "context": "template_context",
    "subcontext": "template_subcontext",
    "template": "template_body"
}

Querying a single template

  • endpoint: GET /templates/:templateId
  • return value: A single Template, with the following structure:
{
    // ... all item store attributes, plus
    "type": "template_type",
    "version": "template_version",
    "context": "template_context",
    "subcontext": "template_subcontext",
    "template": "template_body"
}

Creating templates

  • endpoint: POST /templates
  • query variables: as for item store
  • body: Serialised JSON:
{
    "type": "template_type",
    "version": "template_version",
    "context": "template_context",
    "subcontext": "template_subcontext",
    "template": "template_body"
}

NOTE:

author, last_modified_date, publication_date, tokens, id and uris are automatically created

  • return value: as for item store

Updating templates

  • endpoint: PUT /templates/:templateId
  • query variables: as for item store
  • body: Serialised JSON:
{
    "type": "template_type",
    "version": "template_version",
    "context": "template_context",
    "subcontext": "template_subcontext",
    "template": "template_body"
}
  • return value: as for item store

Deleting templates

  • endpoint: DELETE /templates/:templateId
  • query variables: as for item store
  • return value: as for item store

Articles

Articles are semi-hydrated placeholders for full articles published in AEM (the main TMG CMS), stored for the purpose of associating particles with articles they are embedded in.

Custom

Articles have the following custom attributes, determined by their representation in the main content API:

  • author: (array) The default author attribute created by itemStore is overwritten by the author attribute from the content API.
  • datePublished: (string) The time the article was published in the main CMS (as opposed to publication_date, which is the time when the article was ingested into the particle API. The latter should always be slightly larger (later))
  • dateModified: (string) The time the article was last modified in the main CMS (as opposed to last_modified_date, which is the time when the article was last modified into the particle API. The latter should always be slightly larger (later))
  • active: (boolean) This should always be true, as non-active articles don't get ingested
  • status: (string) pub|draft - should always be pub, as draft articles are not ingested
  • headline: (string) The article headline
  • image: (array) An array of images in the article, with a useful number of renditions for each image
  • channel: (string) The channel the article was published in
  • keywords: (array) An array of keywords (tags) the article is tagged with
  • description: (string) Always empty
  • tmgId: (string) The article id in AEM
  • url: (string) The article's public URL
  • video: (array) An array of videos in the article

Querying articles

  • endpoint: GET /articles
  • query variables: as for item store
  • return value: List of Articles, each with the following structure:
{
    // ... all item store attributes, plus
    "author": [
        "author_fullname_1",
        "author_fullname_2",
        "...",
        "author_fullname_N"
    ],
    "datePublished": "aem-publication-date",
    "dateModified": "aem-modified-date",
    "active": true,
    "status": "pub",
    "headline": "article-headline",
    "image": [
        {
            "renditions": [
            {
                "url": "image-rendition-url",
                "width": 480,
                "height": 320
            },
            {
                "url": "image-rendition-url",
                "width": 320,
                "height": 213
            },
            {
                "url": "image-rendition-url",
                "width": 140,
                "height": 93
            }
            ]
        }
    ],
    "channel": "article-channel",
    "keywords": [
        "article-tag-1",
        "article-tag-2",
        "...",
        "article-tag-N"
    ],
    "description": "",
    "tmgId": "article-aem-id",
    "url": "article-public-url",
    "video": [
        {
            "tmgId": "video-tmg-id-1",
            "url": "video-url-1"
        },
        "...",
        {
            "tmgId": "video-tmg-id-N",
            "url": "video-url-N"
        }
    ]
}
}

Querying a single article

  • endpoint: GET /articles/:articleId
  • return value: A single Article, with the exact same structure as in Querying articles above.

Creating articles

  • endpoint: POST /articles
  • query variables: as for item store
  • body: Serialised JSON, with the exact same structure as in Querying articles above.

NOTE:

last_modified_date, publication_date, and id are automatically created

  • return value: as for item store

Updating articles

  • endpoint: PUT /articles/:articleId
  • query variables: as for item store
  • body: Serialised JSON, with the exact same structure as in Querying articles above.
  • return value: as for item store

Deleting articles

  • endpoint: DELETE /articles/:articleId
  • query variables: as for item store
  • return value: as for item store

Utilities

Handlebars compilation

Compile arbitrary data

  • endpoint: POST /templates/compile/:templateId
  • body: Serialised JSON - data to compile into the template
  • return value: String - the result of compiling the data supplied in the POST body with the template identified by templateId

Compile particle content by context

  • **endpoint: GET /particles/compile/:particleId/:context
  • return value: String - the result of compiling the particle with the first template that matches the type and version of the particle identified by particleId, and that also matches context.

Compile particle content by context and subcontext

  • endpoint: GET /particles/compile/:particleId/:context/:subcontext
  • return value: String - the result of compiling the particle with the first template that matches the type and version of the particle identified by particleId, and that also matches context and subcontext.

Animated gif frame extraction

Single frame

  • endpoint: POST /process-image/extractFrame/:frameNumber/:outputType
  • body: Base64 encoded animated GIF image
  • return value: Base64 encoded frame from GIF image (as image type outputType)

All frames

  • endpoint: POST /process-image/extractFrame/:outputType
  • body: Base64 encoded animated GIF image
  • return value: Array of Base64 encoded frames from GIF image (as image type outputType)

Base64-encode image

  • endpoint: GET /process-image/returnBase64/:imageUrl
  • return value: Base64 encoded image (the image at the url-encoded URL imageUrl)

Finance

Get latest stock price and charts

  • endpoint: GET /finance/:type/:code
  • path parameters:
    • type: One of ukIndex, commodity, or forex
    • code: The ticker symbol
  • return value:

http://particle-api.eip.telegraph.co.uk/finance/ukIndex/BARC

{
    "Epic": "BARC",
    "CompanyName": "Barclays",
    "BidPrice": "241.400000",
    "AskPrice": "211.600000",
    "MidPrice": "226.500000",
    "PreviousClose": "225.900000",
    "MidChange": "0.600000",
    "MidChangePct": "0.270000",
    "CurrentPrice": "225.100000",
    "CurrentChange": "-0.800000",
    "CurrentChangePct": "-0.350000",
    "TradePrice": "225.194000",
    "LastTradeVolume": "376",
    "TradeTime": "2017-02-27 16:30:25",
    "UpdateTime": "2017-02-27 16:32:31",
    "OpenPrice": "225.000000",
    "CumulativeVolume": "74611833",
    "BuyVolume": "26079090",
    "SellVolume": "56297750",
    "Currency": "GBX",
    "HighTradePrice": "228.550000",
    "LowTradePrice": "224.100000",
    "Charts": {
        // Charts at different resolutions
        "300*186": { // 300 X 186 px
            // Time span: one year:
            "YEAR1": "chart-url",
            // Time span: six months:
            "MONTH6": "chart-url",
            // Time span: three months:
            "MONTH3": "chart-url",
            // Time span: one month:
            "MONTH1": "chart-url",
            // Time span: five days:
            "DAY5": "chart-url",
            // Time span: one day:
            "DAY1": "chart-url"
        },
        "400*248": { // 400 X 248 px
            "YEAR1": "chart-url",
            "MONTH6": "chart-url",
            "MONTH3": "chart-url",
            "MONTH1": "chart-url",
            "DAY5": "chart-url",
            "DAY1": "chart-url"
        },
        "584*362": { // 584 X 362 px
            "YEAR1": "chart-url",
            "MONTH6": "chart-url",
            "MONTH3": "chart-url",
            "MONTH1": "chart-url",
            "DAY5": "chart-url",
            "DAY1": "chart-url"
        },
        "700*434": { // 700 X 434 px
            "YEAR1": "chart-url",
            "MONTH6": "chart-url",
            "MONTH3": "chart-url",
            "MONTH1": "chart-url",
            "DAY5": "chart-url",
            "DAY1": "chart-url"
        }
    }
}

http://particle-api.eip.telegraph.co.uk/finance/forex/GBPUSD

{
    "Epic": "GBPUSD",
    "Name": "Pound Sterling (b) vs United States Dollar Spot (GBP/USD)",
    "MidPrice": "1.250000",
    "MidChange": "1.250000",
    "MidPCChange": "0.000000",
    "BidPrice": "1.247650",
    "AskPrice": "1.247750",
    "CurrPrice": "1.247650",
    "CurrChange": "0.001520",
    "CurrPCChange": "0.120000",
    "OpenPrice": "1.245700",
    "ClosePrice": "1.245270",
    "TradePrice": "1.247650",
    "UpdateTime": "2017-02-27 16:53:07",
    "Charts": {
        "300*186": {
            "YEAR1": "chart-url",
            "MONTH6": "chart-url",
            "MONTH3": "chart-url",
            "MONTH1": "chart-url",
            "DAY5": "chart-url",
            "DAY1": "chart-url"
        },
        "400*248": {
            "YEAR1": "chart-url",
            "MONTH6": "chart-url",
            "MONTH3": "chart-url",
            "MONTH1": "chart-url",
            "DAY5": "chart-url",
            "DAY1": "chart-url"
        },
        "584*362": {
            "YEAR1": "chart-url",
            "MONTH6": "chart-url",
            "MONTH3": "chart-url",
            "MONTH1": "chart-url",
            "DAY5": "chart-url",
            "DAY1": "chart-url"
        },
        "700*434": {
            "YEAR1": "chart-url",
            "MONTH6": "chart-url",
            "MONTH3": "chart-url",
            "MONTH1": "chart-url",
            "DAY5": "chart-url",
            "DAY1": "chart-url"
        }
    }
}

http://particle-api.eip.telegraph.co.uk/finance/commodity/US@@DPL.1

{
    "Name": "Platinum",
    "Epic": "US@@DPL.1",
    "Currency": null,
    "CodeCSTK": "JPLc1",
    "MidPrice": "3667.000000",
    "MidChange": "3.000000",
    "MidPCChange": "0.081878",
    "BidPrice": null,
    "AskPrice": null,
    "CurrPrice": "3667.000000",
    "CurrChange": "3.000000",
    "CurrPCChange": "0.081878",
    "OpenPrice": null,
    "ClosePrice": null,
    "UpdateTime": "2017-02-27 17:00:03",
    "Charts": {
        "300*186": {
            "YEAR1": "chart-url",
            "MONTH6": "chart-url",
            "MONTH3": "chart-url",
            "MONTH1": "chart-url",
            "DAY5": "chart-url",
            "DAY1": "chart-url"
        },
        "400*248": {
            "YEAR1": "chart-url",
            "MONTH6": "chart-url",
            "MONTH3": "chart-url",
            "MONTH1": "chart-url",
            "DAY5": "chart-url",
            "DAY1": "chart-url"
        },
        "584*362": {
            "YEAR1": "chart-url",
            "MONTH6": "chart-url",
            "MONTH3": "chart-url",
            "MONTH1": "chart-url",
            "DAY5": "chart-url",
            "DAY1": "chart-url"
        },
        "700*434": {
            "YEAR1": "chart-url",
            "MONTH6": "chart-url",
            "MONTH3": "chart-url",
            "MONTH1": "chart-url",
            "DAY5": "chart-url",
            "DAY1": "chart-url"
        }
    }
}

Snapshot latest stock price and charts

  • endpoint: POST /finance/:type/:code
  • path parameters:
    • type: One of ukIndex, commodity, or forex
    • code: The ticker symbol
  • return value:

http://particle-api.eip.telegraph.co.uk/finance/ukIndex/BARC

{
    "Epic":"BARC",
    "CompanyName":"Barclays",
    "BidPrice":"224.950000",
    "AskPrice":"225.000000",
    "MidPrice":"225.000000",
    "PreviousClose":"225.000000",
    "MidChange":"-0.900000",
    "MidChangePct":"-0.400000",
    "CurrentPrice":"226.059000",
    "CurrentChange":"0.159027",
    "CurrentChangePct":"0.070000",
    "TradePrice":"226.059000",
    "LastTradeVolume":"1368",
    "TradeTime":"2017-02-27 16:51:39",
    "UpdateTime":"2017-02-27 16:51:39",
    "OpenPrice":"225.000000",
    "CumulativeVolume":"141680967",
    "BuyVolume":"26777008",
    "SellVolume":"114683314",
    "Currency":"GBX",
    "HighTradePrice":"228.550000",
    "LowTradePrice":"224.100000",
    "Charts":{
        "300*186":{
            "YEAR1":"chart-snapshot-url",
            "MONTH6":"chart-snapshot-url",
            "MONTH3":"chart-snapshot-url",
            "MONTH1":"chart-snapshot-url",
            "DAY5":"chart-snapshot-url",
            "DAY1":"chart-snapshot-url"
        },
        "400*248":{
            "YEAR1":"chart-snapshot-url",
            "MONTH6":"chart-snapshot-url",
            "MONTH3":"chart-snapshot-url",
            "MONTH1":"chart-snapshot-url",
            "DAY5":"chart-snapshot-url",
            "DAY1":"chart-snapshot-url"
        },
        "584*362":{
            "YEAR1":"chart-snapshot-url",
            "MONTH6":"chart-snapshot-url",
            "MONTH3":"chart-snapshot-url",
            "MONTH1":"chart-snapshot-url",
            "DAY5":"chart-snapshot-url",
            "DAY1":"chart-snapshot-url"
        },
        "700*434":{
            "YEAR1":"chart-snapshot-url",
            "MONTH6":"chart-snapshot-url",
            "MONTH3":"chart-snapshot-url",
            "MONTH1":"chart-snapshot-url",
            "DAY5":"chart-snapshot-url",
            "DAY1":"chart-snapshot-url"
        }
    },
    "snapshotUrl":"full-data-snapshot-url" // Duplicate of this data
}

Legacy finance proxy API TO BE DEPRACATED

  • endpoint: POST /finance/:code
  • path parameters:
    • code: The ticker symbol
  • return value:

http://particle-api.eip.telegraph.co.uk/finance/BARC

{
    "Epic": "BARC",
    "CompanyName": "Barclays",
    "BidPrice": "224.950000",
    "AskPrice": "225.000000",
    "MidPrice": "225.000000",
    "PreviousClose": "225.000000",
    "MidChange": "-0.900000",
    "MidChangePct": "-0.400000",
    "CurrentPrice": "225.000000",
    "CurrentChange": "-0.900000",
    "CurrentChangePct": "-0.400000",
    "TradePrice": "225.000000",
    "LastTradeVolume": "37258896",
    "TradeTime": "2017-02-27 16:50:12",
    "UpdateTime": "2017-02-27 16:50:12",
    "OpenPrice": "225.000000",
    "CumulativeVolume": "140952931",
    "BuyVolume": "26777008",
    "SellVolume": "114683314",
    "Currency": "GBX",
    "HighTradePrice": "228.550000",
    "LowTradePrice": "224.100000"
}

Readme

Keywords

Package Sidebar

Install

npm i particle-api

Weekly Downloads

1

Version

0.0.1

License

ISC

Unpacked Size

921 kB

Total Files

393

Last publish

Collaborators

  • ollieedge
Try on RunKit
Report malware