For Developers

Methods

Relative to the base URI: https://api.ft.com

Content Item Resource Representation

A content item is represented in the API as a JSON data structure (shown below) that is received in the body of a response. This representation is the set of all possible fields a content item can contain.

These fields are grouped together logically as “aspects” of the content. For example, the initial and latest publication dates are grouped together in the “lifecycle” aspect.

Different types of content will not support the same aspects. For example, a slideshow doesn’t support the “summary” aspect. Each content type will have an “aspectSet” that specifies the list of aspects that are applicable for that content type.

Currently, articles and slideshows can be retrieved from the API. An article has an aspectSet of “article”, and a slideshow has an aspectSet of “slideshow”. If the feature is enabled, blogposts can be retrieved as well. A blogpost has an aspectSet of “blogPost”

{
    “aspectSet”: string,
    “aspects”: [ string ],
    “modelVersion”: string,
    “id”: string,
    “apiUrl”: string,
    “title”: {
      “title”: string
    },
  “body”: { “mediaType”: “string”
    “body”: “string”
  },
  “lifecycle”: {
    “initialPublishDateTime”: datetime,
    “lastPublishDateTime”: datetime
  },
  “location”: {
    “uri”: string
  },
  “summary”: {
    “excerpt”: string
  },
  “packaging”: {
    “spHeadline”: string
  },
  “master”: {
    “masterSource”: string,
    “masterEntityId”: string
  },
  “editorial”: {
    “subheading”: string,
    “leadBody”: string,
    “standFirst”: string,
    “byline”: string
  },
  “provenance”: {
    “originatingParty”: string
  },
  “textualBody”: {
    “isImageLed”: boolean
  },
  “usage”: {
    “publications”: [
       {
        “name”: string,
        “id”: string
       }
    ]
  },
  “metadata”: {
    “primarySection”: {
      “term”: {
        “name”: string,
        “id”: string,
        “attributes”:[
          {
            “key” : string
            “value” : string
          }
        ],
        “taxonomy”: string
      }
    },
    “primaryTheme”: {
      “term”: {
        “name”: string,
        “id”: string,
        “attributes”:[
          {
            “key” : string
            “value” : string
          }
        ],
        “taxonomy”: string
      }
    },
    “tags”: [
      {
        “term”: {
          “name”: string,
          “id”: string,
          “attributes”: [
            {
              “key” : string
              “value” : string
            }
          ],
          “taxonomy”: string
        }
      }
    ] ,
    “authors”: [
      {
        “term”: {
          “name”: string,
          “id”: string,
          “taxonomy”: string
        }
      }
    ],
    “brand”: [
      {
        “term”: {
          “name”: string,
          “id”: string,
          “taxonomy”: string
        }
      }
    ],
    “genre”: [
      {
        “term”: {
          “name”: string,
          “id”: string,
          “taxonomy”: string
        }
      }
    ],
    “icb”: [
      {
        “term”: {
          “name”: string,
          “id”: string,
          “taxonomy”: string
        }
      }
    ],
    “iptc”: [
      {
        “term”: {
          “name”: string,
          “id”: string,
          “taxonomy”: string
        }
      }
    ],
    “mediaType”: [
      {
        “term”: {
          “name”: string,
          “id”: string,
          “taxonomy”: string
        }
      }
    ],
    “organisations”: [
      {
        “term”: {
          “name”: string,
          “id”: string,
          “attributes”: [
            {
              “key” : wsod_key
              “value” : string
            },
            {
              “key” : is_company
              “value” : string
            }
          ],
          “taxonomy”: string
        }
      }
    ],
    “people”: [
      {
        “term”: {
          “name”: string,
          “id”: string,
          “taxonomy”: string
        }
      }
    ],
    “regions”: [
      {
        “term”: {
          “name”: string,
          “id”: string,
          “taxonomy”: string
        }
      }
    ],
    “sections”: [
      {
        “term”: {
          “name”: string,
          “id”: string,
          “taxonomy”: string
        }
      }
    ],
    “specialReports”: [
      {
        “term”: {
          “name”: string,
          “id”: string,
          “taxonomy”: string
        }
      }
    ],
    “subjects”: [
      {
        “term”: {
          “name”: string,
          “id”: string,
          “taxonomy”: string
        }
      }
    ],
    “topics”: [
      {
        “term”: {
          “name”: string,
          “id”: string,
          “taxonomy”: string
        }
      }
    ]
  },
  “images”: [
    {
      “url”: string,
      “type”: string,
      “source”: string,
      “alt”: string,
      “caption”: string,
      “height”: number,
      “width”: number,
      “mediaType”: string
    }
  ],
  “package”: [
    {
      “aspectSet”: string,
      “aspects”: [ string ],
      “id”: string,
      “apiUrl”: string,
      “packaging”: {
        “kicker”: string,
        “spHeadline”: string
      },
      “provenance”: {
        “originatingParty”: string
      }
    }
  ],
 “assets”: [
    {
      “type”: string,
      “name”: string,
      “fields”: [
     “title”: string,
           “slides”: [
            “slides”: string,
                  “slideNumber”: number,
      “source”: string,
      “alt”: string,
      “caption”: string,
      “height”: number,
      “width”: number,
      “mediaType”: string
                 ]
       ]
    }
  ],
  “mediaAssets”: [
    {
      “type”: string,
      “name”: string,
      “slideshowHeading”: string,
      “slides”: [
        {“slideNumber”: number
          “url”: string,
          “source”: string,
          “alt”: string,
          “caption”: string,
          “height”: number,
          “width”: number,
          “mediaType”: string
        }
       ]
    }
  ]
}

Content Item Aspects

Content Item Properties

Metadata Term Properties

For organisations metadata, there are two specific attributes:

• is_company - “true” for an organisation that is a company, “false” otherwise
• wsod_key - the Wall Street on Demand key for this company. Example: “uk:VOD”. Attribute only present when there’s a value.

Image Properties

Package Item Properties