Metadata Resource

Metadata Resource

The metadata resources allow users to perform lookups for the fields, field groups and parameters associated with each of the resources available through the DataFied API. For example, if a user is looking to use the Companies Resource, they would first need to know what parameters are available for calling or filtering the available data.

List of Resources /v2/metadata/resources?appkey={APPKEY} List of resources to display from the response:
"resources": {
"name": "CoreFinancials-QTR",
"urlpath": "CoreFinancials/QTR"
},
{ "name": "CoreFinancials-YTD",
"urlpath": "CoreFinancials/YTD" }, …
Resource /v2/metadata/resources/{resourceName}?appkey={APPKEY} Contains name and URLpath of the resource;
example:
{ "name": "Ownership-Issues",
"urlpath": "Ownerships/Issues" }
List of Fields /v2/metadata/resources/{resourceName}/fields?appkey={APPKEY} List of fields for a particular resource; also contains information about the fields;
example:
"fields": [{
"datatype": "Integer",
"label": "RowNumber",
"name": "rownumber",
"hasdescription": false,
"precision": 0 },
{ "datatype": "Integer",
"label": "IssueID",
"name": "issueid",
"hasdescription": true,
"precision": 0 }, ...
Field /v2/metadata/resources/{resourceName}/{fieldName}?appkey={APPKEY} Information about a particular field of a resource;
example: { "datatype": "Integer",
"label": "FilerID",
"name": "filerid",
"hasdescription": true,
"precision": 0 }
List of Fields by Field Groups /v2/metadata/resources/{resourceName}/fieldgroups?appkey={APPKEY} List of field groups of a particular resource;
example:
{ "fieldgroups": [{
"name": "DefaultFieldGroup",
"description": "DefaultFieldGroup description",
"fields": [{
"datatype": "Integer",
"label": "RowNumber",
"name": "rownumber",
"hasdescription": false,
"precision": 0 }, { "datatype": "Boolean",
"label": "isactivecompany",
"name": "isactivecompany",
"hasdescription": true,
"precision": 0 }, ...
Field Group /v2/metadata/resources/{resourceName}/fieldgroups/{fieldgroupName}?appkey={APPKEY} List of fields grouped by Concept Groups (specific to the CoreFinancials resources);
example of response:
{ "name": "BalanceSheetConsolidated",
"description": "BalanceSheetConsolidated",
"fields": [{
"datatype": "Float",
"label": "InventoriesNet",
"name": "inventoriesnet",
"hasdescription": true,
"precision": 0 }, ...
List of Parameters /v2/metadata/resources/{resourceName}/parameters?appkey={APPKEY} List of parameters of a particular resource;
example:
{ "parameters": [{
"name": "fields",
"description": "supply fields list",
"defaultvalue": "CIK,COMPANYNAME,ENTITYID,PRIMARYEXCHANGE,PRIMARYSYMBOL,SICCODE,SICDESCRIPTION",
"hasdescription": false }, { "name": "sortby",
"description": "parameter to sort result set",
"defaultvalue": "PRIMARYSYMBOL ASC,ENTITYID ASC",
"hasdescription": false }, ...
Parameter /v2/metadata/resources/{resourceName}/{parameterName}?appkey={APPKEY} Definition or descriptive Information about a particular parameter of a resource;
example:
{ "name": "ciks",
"description": "parameter to filter the result set by cik",
"defaultvalue": null,
"hasdescription": true }
Examples:
  • Get all resources available via the DataFied API:

http://edgaronline.api.mashery.com/v2/metadata/resources?appkey={APPKEY}

JSON Response:

{
"resources": [{
"name": "CoreFinancials-QTR",
"urlpath": "CoreFinancials/QTR"
}, {
"name": "CoreFinancials-YTD",
"urlpath": "CoreFinancials/YTD"
}, {
"name": "CoreFinancials-TTM",
"urlpath": "CoreFinancials/TTM"
}, {
"name": "CoreFinancials-ANN",
"urlpath": "CoreFinancials/ANN"
}, {
"name": "Companies",
"urlpath": "Companies"
}, {
"name": "Insider-Filers",
"urlpath": "Insiders/Filers"
}, {
"name": "Insider-Issues",
"urlpath": "Insiders/Issues"
}, {
"name": "Insider-Summary",
"urlpath": "Insiders/Summary"
}, {
"name": "Insider-Transactions",
"urlpath": "Insiders/Transactions"
}, {
"name": "Ownership-Issues",
"urlpath": "Ownerships/Issues"
}, {
"name": "Ownership-Owners",
"urlpath": "Ownerships/Owners"
}, {
"name": "Ownership-CurrentIssueHolders",
"urlpath": "Ownerships/CurrentIssueHolders"
}, {
"name": "Ownership-CurrentownerHoldings",
"urlpath": "Ownerships/CurrentOwnerHoldings"
}]
}

  • Get information about Insider-Issue Resource:

http://edgaronline.api.mashery.com/v2/metadata/resources/Insider-Issues?appkey={APPKEY}

  • Get all fields within the Companies Resource:

http://edgaronline.api.mashery.com/v2/metadata/resources/Companies/fields?appkey={APPKEY}

  • Get information about “Filerid” field for the Ownership-Currentissueholders Resource:

http://edgaronline.api.mashery.com/v2/metadata/resources/Ownership-Currentissueholders/fields/filerid?appkey={APPKEY}

  • Get field groups for the Corefinancials-ANN Resource:

http://edgaronline.api.mashery.com/v2/metadata/resources/Corefinancials-ANN/fieldgroups?appkey={APPKEY}

  • Get fields of “GrowthRatios” concept group for the Corefinancials-QTR Resource:

http://edgaronline.api.mashery.com/v2/metadata/resources/corefinancials-qtr/fieldgroups/GrowthRatios?appkey={APPKEY}

  • Get all parameters for the Ownership-Issues Resource:

http://edgaronline.api.mashery.com/v2/metadata/resources/Ownership-Issues/parameters?appkey={APPKEY}

  • Get information about “Primarysymbols” parameter for the Companies Resource:

http://edgaronline.api.mashery.com/v2/metadata/resources/companies/parameters/primarysymbols?appkey={APPKEY}