getdata
Retrieve Twitter data
Syntax
Description
retrieves Twitter data using web service query parameters. The Twitter REST API defines web service query parameters for each endpoint. For
valid parameters, see the Twitter REST API Endpoint Reference Documentation.d
= getdata(c
,baseurl
,parameters
)
specifies web service query parameters as one or more pairs of name-value
arguments.d
= getdata(c
,baseurl
,QueryName1,QueryValue1,...,QueryNameN,QueryValueN
)
Examples
Retrieve Twitter Data Without Specifying Parameters
Use a Twitter connection object to return locations for trending topics. The
REST API endpoint GET trends/available
does not require any
web service query parameters.
Create a Twitter connection using your credentials. (The values in this example do not represent real Twitter credentials.)
consumerkey = 'abcdefghijklmnop123456789'; consumersecret = 'qrstuvwxyz123456789'; accesstoken = '123456789abcdefghijklmnop'; accesstokensecret = '123456789qrstuvwxyz'; c = twitter(consumerkey,consumersecret,accesstoken,accesstokensecret);
Check the Twitter connection. If the StatusCode
property has the value
OK
, the connection is successful.
c.StatusCode
ans = OK
Specify the Twitter base URL.
baseurl = 'https://api.twitter.com/1.1/trends/available.json';
Retrieve locations for trending topics using the Twitter connection object and the base URL.
d = getdata(c,baseurl)
d = ResponseMessage with properties: StatusLine: 'HTTP/1.1 200 OK' StatusCode: OK Header: [1×25 matlab.net.http.HeaderField] Body: [1×1 matlab.net.http.MessageBody] Completed: 0
d
is a matlab.net.http.ResponseMessage
object. The
StatusCode
property shows OK
,
indicating a successful HTTP request.
Access the location data. Display the structure
Data
.
d.Body.Data
ans = 467×1 struct array with fields: name placeType url parentid country woeid countryCode
The structure Data
is a structure array with the field
name
, which contains the name of a location for a
trending topic.
Access the first location.
d.Body.Data(1).name
ans = 'Worldwide'
You can retrieve data for other REST API endpoints by substituting another
URL for the baseurl
input argument. Or, you can search
for Tweets using the search
function.
Retrieve Twitter Data Using Structure
Use a Twitter connection object to retrieve follower information. Specify the count of followers as a structure.
Create a Twitter connection using your credentials. (The values in this example do not represent real Twitter credentials.)
consumerkey = 'abcdefghijklmnop123456789'; consumersecret = 'qrstuvwxyz123456789'; accesstoken = '123456789abcdefghijklmnop'; accesstokensecret = '123456789qrstuvwxyz'; c = twitter(consumerkey,consumersecret,accesstoken,accesstokensecret);
Check the Twitter connection. If the StatusCode
property has the value
OK
, the connection is successful.
c.StatusCode
ans = OK
Set the Twitter base URL to access the GET followers/list
REST API endpoint. Specify one follower by defining the structure
parameters
with the field set to 1. Search for one
follower of the current account using the Twitter connection object, base URL, and structure
parameters
.
baseurl = 'https://api.twitter.com/1.1/followers/list.json';
parameters.count = 1;
d = getdata(c,baseurl,parameters)
d = ResponseMessage with properties: StatusLine: 'HTTP/1.1 200 OK' StatusCode: OK Header: [1×25 matlab.net.http.HeaderField] Body: [1×1 matlab.net.http.MessageBody] Completed: 0
d
is a matlab.net.http.ResponseMessage
object. The
StatusCode
property shows OK
,
indicating a successful HTTP request.
Access information about the follower.
d.Body.Data.users
ans = struct with fields: id: 12345678 id_str: '12345678' name: 'Full Name' ...
d.Body.Data.users
is a structure that has a field for
each piece of account information. For example, the first three fields are:
Account identifier as a number
Account identifier as a character vector
Full name of the account as a character vector
(These values do not represent real Twitter data.)
You can retrieve data for other REST API endpoints by substituting another
URL for the baseurl
input argument. Or, you can search
for Tweets using the search
function.
Retrieve Twitter Data Using Name-Value Arguments
Use a Twitter connection object to retrieve follower information. Specify the count of followers as a name-value argument.
Create a Twitter connection using your credentials. (The values in this example do not represent real Twitter credentials.)
consumerkey = 'abcdefghijklmnop123456789'; consumersecret = 'qrstuvwxyz123456789'; accesstoken = '123456789abcdefghijklmnop'; accesstokensecret = '123456789qrstuvwxyz'; c = twitter(consumerkey,consumersecret,accesstoken,accesstokensecret);
Check the Twitter connection. If the StatusCode
property has the value
OK
, the connection is successful.
c.StatusCode
ans = OK
Set the Twitter base URL to access the GET followers/list
REST API endpoint. Search for one follower of the current account using the
Twitter connection object, base URL, and name-value argument
count
.
baseurl = 'https://api.twitter.com/1.1/followers/list.json'; d = getdata(c,baseurl,'count',1)
d = ResponseMessage with properties: StatusLine: 'HTTP/1.1 200 OK' StatusCode: OK Header: [1×25 matlab.net.http.HeaderField] Body: [1×1 matlab.net.http.MessageBody] Completed: 0
d
is a matlab.net.http.ResponseMessage
object. The
StatusCode
property shows OK
,
indicating a successful HTTP request.
Access information about the follower.
d.Body.Data.users
ans = struct with fields: id: 12345678 id_str: '12345678' name: 'Full Name' ...
d.Body.Data.users
is a structure that has a field for
each piece of account information. For example, the first three fields are:
Account identifier as a number
Account identifier as a character vector
Full name of the account as a character vector
(These values do not represent real Twitter data.)
You can retrieve data for other REST API endpoints by substituting another
URL for the baseurl
input argument. Or, you can search
for Tweets using the search
function.
Input Arguments
c
— Twitter connection
twitter
object
Twitter connection, specified as a twitter
object.
baseurl
— Twitter base URL
character vector | string scalar
Twitter base URL, specified as a character vector or string scalar. Use this URL to access the Twitter REST API endpoints.
Example: 'https://api.twitter.com/1.1/followers/list.json'
specifies a GET
REST API endpoint.
Data Types: char
| string
parameters
— Web service query parameters
structure
Web service query parameters, specified as a structure. Each parameter is specified as a field in the structure. Set the field to a specific value in the structure. For example, specify the number of items for the HTTP request:
parameters.count = 20;
The Twitter REST API defines web service query parameters that it accepts as part of an HTTP request. For valid parameters, see the Twitter REST API Endpoint Reference Documentation.
Data Types: struct
QueryName1,QueryValue1,...,QueryNameN,QueryValueN
— Web service query parameters
name-value pairs
Web service query parameters, specified as one or more pairs of name-value arguments. A QueryName
argument is a character vector or string scalar that specifies the name of a query parameter. A QueryValue
argument is a character vector or string scalar that specifies the value of the query parameter.
The Twitter REST API defines web service query parameters that it accepts as part of an HTTP request. For valid parameters, see the Twitter REST API Endpoint Reference Documentation.
Example: 'count',20
specifies the number of items for the HTTP
request.
Data Types: char
| string
Output Arguments
d
— Twitter data
matlab.net.http.ResponseMessage
Twitter data, returned as a matlab.net.http.ResponseMessage
object.
To retrieve Twitter data, access properties in d
, for example:
data = d.Body.Data
data = struct with fields: statuses: {50×1 cell} search_metadata: [1×1 struct]
Continue to access the nested structure data
to retrieve Twitter data. For accessing nested structures, see Access Data in Nested Structures.
Limitations
Each Twitter REST GET API endpoint has its own limitations. For details, see the Twitter REST API Endpoint Reference Documentation.
Version History
Introduced in R2017b
See Also
Functions
Objects
External Websites
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)