Corpus Search

Statistics and information about the whole corpus.

get/search/corp_info

Request

  • The document declares no server URL.
  • Auth: HTTP basic

Query parameters

corpnamestring required

Corpus name. To query your own corpus (e.g. username john, corpus mycorpus), use value user/john/mycorpus.

usesubcorpstring

The name of the subcorpus. The default value empty string refers to the entire corpus. An example for preloaded/bnc2_tt21 can be Written Academic or 1960-1974.

subcorpora0 | 1

A parameter to obtain the list of subcorpora and their sizes (e.g. number of tokens, words).

gramrels0 | 1

A list of grammatical relations from the correspoding sketch grammar.

corpcheck0 | 1

Results of the last corpcheck (if available in the compilation log).

registry0 | 1

The content of the registry file (registry_dump and registry_text).

struct_attr_stats0 | 1

The lexicon sizes of structure attributes.

format'json' | 'xml' | 'csv' | 'tsv' | 'txt' | 'xls'

The format of the output. Empty value is interpreted as JSON. Not every endpoint supports all formats.

Response

OK

structsstring[]

A list of structures in the corpus.

namestring

The full name of the corpus.

langstring

The language of the corpus.

infohrefstring

An URL with more information about the corpus. Empty string if none.

infostring

More information about the corpus.

encodingstring

The used character encoding in the corpus.

tagsetdocstring

An URL with more information about the POS tagger used in the corpus. Information like meanings of POS tags, comparition with other tagsets for specified language etc.

defaultattrstring

The default attribute for the corpus. Usually word or lc.

starattrstring
unicameralboolean

A boolean value indicating if the corpus is unicameral (not distinguishing between upper and lower case).

righttoleftboolean

The order of writing in language of the used corpus.

errsetdocstring
wsattrstring

The attribute name for which word sketches are computed, e.g. lempos.

wsdefstring

A path to the used word sketches grammar definition file.

termdefstring

A path to the term grammar definition file used in the corpus.

diachronicstring[]

A list of diachronic subcorporas. Diachronic corpus is corpus with timestamps to watch development of the language in time.

freqttattrsstring[]

A list of attributes (text types) that will be used for Frequency. Text types are metadata attached to the corpus structures. You can access it via Sketch Engine dashboard -> Corpus Info -> Text Type Analysis.

subcorpattrsstring[]

A list of subcorpus attributes for the corpus.

shortrefstring

The attribute of a structure to display as a default reference in the left-hand column of a concordance. The syntax is like =structure.attribute, e.g. =doc.id for displaying only the value of doc.id.

docstructurestring

A structures that is considered as individual documents. Usually doc.

newversionstring

Information about the new version of the corpus, if available. Empty string if not.

is_error_corpusboolean

A boolean value indicating if the corpus is an error corpus (not compiled etc.).

structctxstring

The structural context for the corpus. Empty string if none.

deffilerlinkboolean

A boolean value indicating if the default filter link is enabled.

defaultstructsstring[]

A list of default structures for the corpus.

wsttattrsstring

The text types for which the word highlights Read more are computed.

terms_compiledboolean

A boolean value indicating if the terms file is compiled.

compiledstring

A date of compilation in format mm/dd/yyyy hh:mm:ss.

gramrelsstring[]
alsizesstring[]

A list of tuples containing sizes of aligned corpora.

registry_dumpstring

The registry dump for the corpus (detailed information about corpus setting), if the registry parameter is set.

registry_textstring

The registry text for the corpus (detailed information about corpus setting), if the registry parameter is set.

api_versionstring

Current API version.

manatee_versionstring

Current version of Manatee.

Example response

{
  "wposlist": [
    [
      "[\"adjective\",\"J.*\"]"
    ]
  ],
  "lposlist": [
    [
      "[\"adjective\",\"-j\"]"
    ]
  ],
  "wsposlist": [
    [
      "[\"adjective\",\"-j\"]"
    ]
  ],
  "attributes": [
    {
      "name": "lempos_lc",
      "id_range": 524493,
      "label": "lempos(lowercase)",
      "dynamic": "utf8lowercase",
      "fromattr": "lempos"
    }
  ],
  "name": "British National Corpus (BNC)",
  "lang": "English",
  "infohref": "https://www.sketchengine.eu/british-national-corpus/",
  "info": "A balanced English corpus of samples of a written and spoken language of British English from the later part of the 20th century (1969–1994). The spoken part is accompanied by audio recordings.",
  "encoding": "UTF-8",
  "tagsetdoc": "https://www.sketchengine.eu/english-treetagger-pipeline-2/",
  "defaultattr": "lc",
  "wsattr": "lempos_lc",
  "wsdef": "/corpora/wsdef/english-penn_tt-3.1.wsdef.m4",
  "termdef": "/corpora/wsdef/english-penn_tt-terms-3.1.termdef.m4",
  "diachronic": [
    "bncdoc.year"
  ],
  "aligned": [
    [
      "a_czech"
    ]
  ],
  "aligned_details": [
    {
      "name": "Example_1",
      "language_name": "Czech",
      "Wposlist": [
        {
          "n": "noun",
          "v": "k1.*"
        }
      ],
      "Lposlist": [
        {
          "n": "noun",
          "v": "-n"
        }
      ],
      "tagsetdoc": "https://www.sketchengine.eu/tagset-reference-for-czech"
    }
  ],
  "freqttattrs": [
    "[\"bncdoc.alltyp\", \"bncdoc.alltim\", \"bncdoc.author\", \"bncdoc.wripp\", \"bncdoc.sporeg\", \"bncdoc.scgdom\", \"bncdoc.wridom\", \"bncdoc.spolog\", \"event.desc\", \"bncdoc.wrimed\", \"bncdoc.year\", \"bncdoc.genre\"]"
  ],
  "subcorpattrs": [
    "[\"bncdoc.alltyp\", \"bncdoc.alltim\", \"bncdoc.author\", \"bncdoc.wripp\", \"bncdoc.sporeg\", \"bncdoc.scgdom\", \"bncdoc.wridom\", \"bncdoc.spolog\", \"event.desc\", \"bncdoc.wrimed\", \"bncdoc.year\", \"bncdoc.genre\"]"
  ],
  "shortref": "=bncdoc.alltyp",
  "docstructure": "bncdoc",
  "structures": [
    {
      "name": "head",
      "attributes": [
        {
          "name": "rend",
          "size": 5
        }
      ],
      "size": 14868944
    }
  ],
  "terms_compiled": true,
  "compiled": "06/30/2017 07:34:25",
  "sizes": {
    "tokencount": "112345722",
    "wordcount": "96134547",
    "doccount": "4054",
    "parcount": "1514906",
    "sentcount": "6052190",
    "normsum": "96134547"
  },
  "subcorpora": [
    {
      "n": "Test",
      "name": "Test",
      "user": 1,
      "tokens": 271454,
      "relsize": 0.24162379765559744,
      "words": 232283,
      "struct": "s",
      "query": "Q:q[lc=\"dog\" | lemma_lc=\"dog\"]"
    }
  ],
  "api_version": "5.62.3",
  "manatee_version": "2.36.7-SkE-2.219.2",
  "request": {
    "subcorpora": "1",
    "struct_attr_stats": "1",
    "corpname": "preloaded/bnc2_tt21"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.