# Welcome! ## Welcome to the Fide API Documentation Here you'll find all the documentation you need to integrate the Fide API into your team's product, dataflow, or process. ## Want to jump right in? Feeling eager? Jump in to the quick start docs and get making your first request: #### *QUICK START COMING SOON!* ## Want to deep dive? Dive a little deeper and start exploring our API reference to get an idea of everything that's possible with the API: {% content-ref url="/pages/tS9niBvFrUPGiskxAfDm" %} [API](/api) {% endcontent-ref %} # API The Fide REST API can be used to interact with the Fide database programmatically. ## API Resources {% hint style="info" %} is the GraphQL Endpoint. Query definitions coming soon! {% endhint %} ## *A simple example of a "blockchain\_address" entity query* {% tabs %} {% tab title="GraphQL" %} ### Try It Now! {% embed url="" %} POST Endpint ```graphql https://api.fide.id ``` \ Query ```graphql query getEntity($fide_id: String, $blockchain_address: String) { entity(input:{fide_id:$fide_id, blockchain_address: $blockchain_address}) { blockchain_addresses links fide_id } } ``` Variables ```graphql { "blockchain_address": "0x0fb213a1af101b1429e6ad3020ad92fb0d25eb1e" } ``` Headers ```graphql { "x-api-key": "YOUR_API_KEY" } ``` {% endtab %} {% tab title="JavaScript" %} ```javascript var myHeaders = new Headers(); myHeaders.append("Content-Type", "application/json"); myHeaders.append("x-api-key", "YOUR_API_KEY"); var graphql = JSON.stringify({ query: "query getEntity($fide_id: String, $blockchain_address: String) {\r\n entity(input:{fide_id:$fide_id, blockchain_address: $blockchain_address}) {\r\n blockchain_addresses\r\n links\r\n fide_id\r\n }\r\n}", variables: {"blockchain_address":"0x0fb213a1af101b1429e6ad3020ad92fb0d25eb1e"} }) var requestOptions = { method: 'POST', headers: myHeaders, body: graphql, redirect: 'follow' }; fetch("https://api.fide.id", requestOptions) .then(response => response.text()) .then(result => console.log(result)) .catch(error => console.log('error', error)); ``` {% endtab %} {% tab title="cURL" %} ```javascript curl --location 'https://api.fide.id' \ --header 'Content-Type: application/json' \ --header 'x-api-key: YOUR_API_KEY' \ --data '{"query":"query getEntity($fide_id: String, $blockchain_address: String) {\r\n entity(input:{fide_id:$fide_id, blockchain_address: $blockchain_address}) {\r\n blockchain_addresses\r\n links\r\n fide_id\r\n }\r\n}","variables":{"blockchain_address":"0x0fb213a1af101b1429e6ad3020ad92fb0d25eb1e"}}' ``` {% endtab %} {% tab title="Python" %} ```python import requests import json url = "https://api.fide.id" payload = "{\"query\":\"query getEntity($fide_id: String, $blockchain_address: String) {\\r\\n entity(input:{fide_id:$fide_id, blockchain_address: $blockchain_address}) {\\r\\n blockchain_addresses\\r\\n links\\r\\n fide_id\\r\\n }\\r\\n}\",\"variables\":{\"blockchain_address\":\"0x0fb213a1af101b1429e6ad3020ad92fb0d25eb1e\"}}" headers = { 'Content-Type': 'application/json', 'x-api-key': 'YOUR_API_KEY' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text) ``` {% endtab %} {% tab title="C#" %} ```csharp var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Post, "https://api.fide.id"); request.Headers.Add("x-api-key", "YOUR_API_KEY"); var content = new StringContent("{\"query\":\"query getEntity($fide_id: String, $blockchain_address: String) {\\r\\n entity(input:{fide_id:$fide_id, blockchain_address: $blockchain_address}) {\\r\\n blockchain_addresses\\r\\n links\\r\\n fide_id\\r\\n }\\r\\n}\",\"variables\":{\"blockchain_address\":\"0x0fb213a1af101b1429e6ad3020ad92fb0d25eb1e\"}}", null, "application/json"); request.Content = content; var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync()); ``` {% endtab %} {% tab title="Go" %} ``` package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://api.fide.id" method := "POST" payload := strings.NewReader("{\"query\":\"query getEntity($fide_id: String, $blockchain_address: String) {\\r\\n entity(input:{fide_id:$fide_id, blockchain_address: $blockchain_address}) {\\r\\n blockchain_addresses\\r\\n links\\r\\n fide_id\\r\\n }\\r\\n}\",\"variables\":{\"blockchain_address\":\"0x0fb213a1af101b1429e6ad3020ad92fb0d25eb1e\"}}") client := &http.Client { } req, err := http.NewRequest(method, url, payload) if err != nil { fmt.Println(err) return } req.Header.Add("Content-Type", "application/json") req.Header.Add("x-api-key", "YOUR_API_KEY") res, err := client.Do(req) if err != nil { fmt.Println(err) return } defer res.Body.Close() body, err := ioutil.ReadAll(res.Body) if err != nil { fmt.Println(err) return } fmt.Println(string(body)) } ``` {% endtab %} {% endtabs %} {% content-ref url="/pages/2YravcNWM4BDicRl8kPV" %} [Entity Schema](/api/entity-schema) {% endcontent-ref %} {% content-ref url="/pages/FoTYhx6YtWcDAUhviZrs" %} [Source Schema](/api/source-schema) {% endcontent-ref %} {% content-ref url="/pages/x5eaHDSx4K3kPwpnNQVa" %} [Contribution Schema](/api/contribution-schema) {% endcontent-ref %} {% content-ref url="/pages/zOy5v9Qsipp2PivRHE9g" %} [Authentication](/api/authentication) {% endcontent-ref %} {% content-ref url="/pages/td13xATvnRnnXbJTiu36" %} [Legacy Endpoints](/api/legacy-endpoints) {% endcontent-ref %} # Entity Schema {% hint style="success" %} *New GraphQL definitions coming soon! Fields subject to change without notice during beta.* {% endhint %} {% hint style="info" %} A Fide Entity will always represent a person, project, or legal organization. {% endhint %} > **Standard `{"key" : "value"}` JSON schema for all Fide Entities from an** [**Entity Endpoint**](/api/legacy-endpoints#entity)**.**
keytypedescription
fide_idstringFide's unique identifier for the Entity
namesdictionaryNames
imagesdictionaryImages
descriptionsdictionaryDescriptions
timesdictionaryTimes
typesstring[]Type
tagsstring[]Tags
linksdictionaryLinks

(twitter, discord, telegram, arkham, blockdata, cookbook, cyberconnect, disco, friendtech, lenster, github, linkedin, messari, moralis, opensea, poap, spotify, zapper, golden, and more)
statisticsdictionaryStatistics
teamdictionaryContributions from entities
experiencesdictionaryContributions to entities
subsidiariesdictionary

Contributions from entities

(ex: "child" entities this "parent" entity receives contributions from)

parent_companiesdictionary

Contributions to entities

(ex: the "parent" entities this "child" entity contributes to)

sources_createddictionaryContributions to sources
investorsdictionaryContributions from entities
investmentsdictionaryContributions to entities
locationsdictionaryContributions to source
(ex: "location" sources this entity contributes to such as organization headquarters)
ecosystemsdictionaryContributions (to entities)
fide_time_createdunix timestamptime Fide Source was created
fide_time_updatedunix timestamptime Fide Source was updated
## Links | key | type | description | | ---------------- | ------------ | ----------------- | | fide\_source\_id | `string` | | | source\_name | `string` | | | identifiers | `dictionary` | LINK IDENTIFIERS | | statistics | `dictionary` | LINK STATISTICS | | descriptions | `dictionary` | LINK DESCRIPTIONS | ## LINK IDENTIFIERS { bsonType: 'object', properties: { id: { bsonType: 'string' }, slug: { bsonType: 'array', items: { bsonType: 'string' } }, blockchain\_address: { bsonType: 'string' }, blockchain\_hash: { bsonType: 'string' } } } ## LINK STATISTICS republications\_count: { bsonType: 'int' }, publication\_replies\_count: { bsonType: 'int' }, publication\_quotes\_count: { bsonType: 'int' }, collects\_count: { bsonType: 'int' }, followers\_count: { bsonType: 'int' }, following\_count: { bsonType: 'int' }, subscribers\_count: { bsonType: 'int' }, subscriptions\_count: { bsonType: 'int' }, views\_count: { bsonType: 'int' }, likes\_count: { bsonType: 'int' }, deployments\_count: { bsonType: 'int' }, saves\_count: { bsonType: 'int' }, publications\_count: { bsonType: 'int' } ## LINK DESCRIPTIONS short location\_name ## Contributions | key | type | description | | ------------------- | -------------- | ------------------------------------------------- | | contributions | `dictionary[]` | [`Contribution Schema`](/api/contribution-schema) | | item\_count | `number` | the total number of items | | per\_page | `number` | the total number of items per page | | current\_page | `number` | the current page number | | page\_count | `number` | the total number of pages | | has\_previous\_page | `boolean` | if has previous page | | has\_next\_page | `boolean` | if has next page | ## Names | key | type | description | | --------- | ---------- | ----------------------------------------------- | | all | `string[]` | names in order of prominence | | first | `string` | legal first name | | middle | `string[]` | legal middle name(s) | | last | `string` | legal first name | | symbol | `string` | official token or ticker symbol | | pseudonym | `string` | commonly used digital name | | prefixes | `string[]` | a word, letter, or number placed before a name. | | suffixes | `string[]` | a word, letter, or number placed after a name. | ## Images
keytypedescription
primarystringprimary image url
secondarystringsecondary image url
tertiarystringtertiary image url
bannerstringbanner image url
## Descriptions
keytypedescription
shortstring>200 characters
mediumstring200-500 characters
longstring<500 characters
technicalstringtechnical description
token_usagestringtoken_usage description
regulationstringregulation description
governance_off_chainstringgovernance_off_chain description
governance_on_chainstringgovernance_on_chain description
## Times
keytypedescription
startunix timestamptime project or organization first active
start_rangenumberconfidence range equally distributed before and after start measured in milliseconds
endunix timestamptime project or organization last inactive
end_rangenumberconfidence range equally distributed before and after end measured in milliseconds
first_blockchain_transactionunix timestamptime of first transaction on any immutable blockchain
## Statistics
keytypedescription
followers_countnumberlatest count of "followers" or similar
following_countnumberlatest count of "following" or similar
subscribers_countnumberlatest count of "subscribers" or similar
subscriptions_countnumberlatest count of "subscriptions" or similar
views_countnumberlatest count of "views", "visits", "impressions" or similar
likes_countnumberlatest count of "likes", "favorites", "stars", "hearts" or similar
deployments_countnumberlatest count of "deployments", "times published" or similar
saves_countnumberlatest count of "saves" or similar
publications_count
publication_quotes_count
publication_replies_count
republications_count
## Type
valuedescription
person
project
organization
## Tags
valuedescription
entrepreneurhas been a start-up founder
tool
web3_powered
event_focused
web3_focused
dao_focused
tool
media_outlet
dao
web3_token
blockchain
layer_1
layer_2
hackathon_project
hackathon
erc_20
# Source Schema {% hint style="success" %} *New GraphQL definitions coming soon! Fields subject to change without notice during beta.* {% endhint %} {% hint style="info" %} A Fide Source will always have a digital location such as a blockchain address or url. {% endhint %} > **Standard `{"key" : "value"}` JSON schema for all Fide Sources from a** [**Source Endpoint**](/api/legacy-endpoints#source)**.**
keytypedescription
fide_source_idstringFide's unique identifier for the source
typesstring[]Types
tagsstring[]Tags
source_namestringname as defined in Fide Sources
identifiersdictionaryIdentifiers associated with the source_name and query_name as defined in Fide Sources
urlstringprimary web address if published, primary archive web address if unpublished
imagesdictionaryImages
descriptionsdictionaryDescriptions
functionsdictionary[]Functions
timesdictionaryTimes
statisticsdictionaryStatistics
physical_locationdictionaryLocation
blockchain_ecosystemsstring[]Blockchain Ecosystems
fide_time_createdunix timestamptime Fide Source was created
fide_time_updatedunix timestamptime Fide Source was updated
contributorsContribution List
## Identifiers
keytypedescription
idstringunique identifier assigned by the source
slugstringlatest alphanumeric identifier (ex: "username", "handle")
blockchain_hashstringa unique hash identifying a blockchain interaction
blockchain_addressstring[]unique address on blockchain (ex: "wallet address" , "smart contract address")
ensstring[]ens domain(s) of the current blockchain_address (ending with ".eth")
lensstring[]lens domain(s) of the current blockchain_address (ending with ".lens")
## Images
keytypedescription
primarystringprimary image url
secondarystringsecondary image url
tertiarystringtertiary image url
bannerstringbanner image url
## Descriptions
keytypedescription
shortstring>200 characters
mediumstring200-500 characters
longstring<500 characters
versionstringlatest "version", "release number", or similar
## Functions
keytypedescription
namestring
descriptionstring
variablestuple
versionstringlatest "version", "release number", or similar
## Times
keytypedescription
startunix timestamptime first published or active
start_rangenumberconfidence range equally distributed before and after start measured in milliseconds
updatedunix timestamptime last updated
updated_rangenumberconfidence range equally distributed before and after updated measured in milliseconds
endunix timestamptime last unpublished or deactivated
end_rangenumberconfidence range equally distributed before and after end measured in milliseconds
## Location
keytypedescription
formatted_addressstringcomplete address
latstringlatitude
lngstringlongitude
ne_viewport_latstringnortheast viewport latitude
ne_viewport_lngstringnortheast viewport longitude
sw_viewport_latstringsouthwest viewport latitude
sw_viewport_lngstringsouthwest viewport longitude
address_componentsdictionary[]Address Components
### Address Components
keytypedescription
typesstring[]Google Place Types
long_namestringcomponent's long name
long_namestringcomponent's short name
## Statistics
keytypedescription
followers_countnumberlatest count of "followers" or similar
following_countnumberlatest count of "following" or similar
subscribers_countnumberlatest count of "subscribers" or similar
subscriptions_countnumberlatest count of "subscriptions" or similar
views_countnumberlatest count of "views", "visits", "impressions" or similar
likes_countnumberlatest count of "likes", "favorites", "stars", "hearts" or similar
deployments_countnumberlatest count of "deployments", "times published" or similar
saves_countnumberlatest count of "saves", "forks" or similar
## Types
valuedescription
profilea digital location representing a single Entity
web_appapplication software access using a web browser
technical_documentationtechnical documentation
foruma digital location where ideas and views on a particular topic can be exchanged.
postany digital publication
articleany post in article format
videoany post in video format
audioany post in audio format
project_auditany post considered to be an analysis of a single project Entity
blockchain_contract_auditany project_audit considered to be an analysis of a blockchain_contract
blockchain_addressa unique identifier used to send, receive and store digital assets on a blockchain network
blockchain_walleta blockchain_address with a private key
blockchain_contracta blockchain_address with on-chain code
blockchain_transactiona blockchain transaction
physical_locationrepresentative of a physical location
physical_eventan event with physical components (hosted in-person)
digital_eventan event with digital components (hosted digitally)
## Tags
valuedescription
publishedis currently published
unpublishedwas previously published and is currently unpublished
updatedhas ever been updated
deployablecan currently be deployed
erc_20the ERC-20 token standard for fungible tokens
erc_721the ERC-721 token standard for non-fungible tokens (NFTs)
erc_777the ERC-777 7token standard for fungible tokens
erc_1155the ERC-1155 token standard for multiple token types
erc_4626the ERC-4626 tokenized vault standard
professionalprofessional representation of a single Entity
# Contribution Schema {% hint style="success" %} *New GraphQL definitions coming soon! Fields subject to change without notice during beta.* {% endhint %} {% hint style="info" %} A Fide Contribution will always represent a one-way relationship between two entities, sources, and/or contributions. {% endhint %} > **Standard `{"key" : "value"}` JSON schema for all Fide Entities from a** [**Contribution Endpoint**](/api/legacy-endpoints#entity)**.** ## Contribution
keytypedescription
fide_contribution_idstringFide's unique identifier for the Contribution
sourcedictionarySource
entitydictionaryEntity
fromSource or Entity (/contributions only)
toSource or Entity (/contributions only)
descriptionsdictionaryDescriptions
timesdictionaryTimes
statisticsdictionaryStatistics
locationsdictionaryLocations
typesstring[]Types
tagsstring[]Tags
fide_time_createdunix timestamptime Fide Source was created
fide_time_updatedunix timestamptime Fide Source was updated
## Descriptions
keytypedescription
shortstring>200 characters
mediumstring200-500 characters
longstring<500 characters
## Times
keytypedescription
startunix timestamptime contribution started
start_rangenumberconfidence range equally distributed before and after start measured in milliseconds
endunix timestamptime contribution ended
end_rangenumberconfidence range equally distributed before and after end measured in milliseconds
## Locations
keytypedescription
formatted_addressstringcomplete address
latstringlatitude
lngstringlongitude
ne_viewport_latstringnortheast viewport latitude
ne_viewport_lngstringnortheast viewport longitude
sw_viewport_latstringsouthwest viewport latitude
sw_viewport_lngstringsouthwest viewport longitude
address_componentsdictionary[]Address Components
### Address Components
keytypedescription
typesstring[]Google Place Types
long_namestringcomponent's long name
long_namestringcomponent's short name
## Statistics
keytypedescription
followers_countnumberlatest count of "followers" or similar
following_countnumberlatest count of "following" or similar
subscribers_countnumberlatest count of "subscribers" or similar
subscriptions_countnumberlatest count of "subscriptions" or similar
views_countnumberlatest count of "views", "visits", "impressions" or similar
likes_countnumberlatest count of "likes", "favorites", "stars", "hearts" or similar
deployments_countnumberlatest count of "deployments", "times published" or similar
saves_countnumberlatest count of "saves" or similar
## Types
valuedescription
profilea digital location representing a single Entity
web_appapplication software access using a web browser
technical_documentationtechnical documentation
foruma digital location where ideas and views on a particular topic can be exchanged.
postany digital publication
articleany post in article format
videoany post in video format
audioany post in audio format
project_auditany post considered to be an analysis of a single project Entity
blockchain_contract_auditany project_audit considered to be an analysis of a blockchain_contract
blockchain_addressa unique identifier used to send, receive and store digital assets on a blockchain network
blockchain_walleta blockchain_address with a private key
blockchain_contracta blockchain_address with on-chain code
blockchain_transactiona blockchain transaction
physical_locationrepresentative of a physical location
physical_eventan event with physical components (hosted in-person)
digital_eventan event with digital components (hosted digitally)
### Tags
valuedescription
publishedis currently published
unpublishedwas previously published and is currently unpublished
updatedhas ever been updated
deployablecan currently be deployed
professionalprofessional representation of a single Entity
erc_20the ERC-20 token standard for fungible tokens
erc_721the ERC-721 token standard for non-fungible tokens (NFTs)
erc_777the ERC-777 7token standard for fungible tokens
erc_1155the ERC-1155 token standard for multiple token types
erc_4626the ERC-4626 tokenized vault standard
*** ### Blockchain Ecosystems
valuedescription
bitcoin
ethereum
litecoin
primecoin
mazacoin
namecoin
arbitrum
xdc
peercoin
ethereum_classic
bitcoin_cash
cardano
tron
tezos
bitcoin_sv
Possible Blockchain Ecosystem Values ```json [ "ethereum_classic", "bitcoin_cash", "cardano", "tron", "tezos", "bitcoin_sv", "lightning_network", "algorand", "solana", "polkadot", "avalanche", "mobilecoin", "internet_computer", "deso", "terra classic", "terra_2", "stellar", "eosio", "lbry", "ripple", "stacks", "vertcoin", "hedera_hashgraph", "zcash", "monero", "bitcoin_gold", "dogecoin", "hyperledger_fabric", "corda", "polygon", "binance_smart_chain", "quorum", "aptos", "near", "iota", "nano" ] ```
# Authentication Please reach out to # Legacy Endpoints {% hint style="warning" %} Fide is moving to a GraphQL API to make requests and responses fully dynamic! {% endhint %} ## Entity {% hint style="info" %} A Fide Entity will always be a person, project, or legal organization. {% endhint %} {% content-ref url="/pages/2YravcNWM4BDicRl8kPV" %} [Entity Schema](/api/entity-schema) {% endcontent-ref %} ## Get profile information for a single entity identified by a unique Fide ID. `POST` `https://api.fide.id/entity` Try It Now! #### Request Body | Name | Type | Description | | ------------------------------------------ | ------ | ----------- | | fide\_id\* | string | | {% tabs %} {% tab title="200: OK dictionary" %} {% endtab %} {% endtabs %} ## Build a list of Fide entities filtered by a unique query. `POST` `https://api.fide.id/entities` #### Request Body | Name | Type | Description | | --------------------------------------- | ---------- | ----------------------------------------------------- | | query\* | dictionary | [Broken mention](broken://pages/97XP4Wk3qyI4f9v1aZRM) | {% tabs %} {% tab title="200: OK dictionary\[]" %} {% endtab %} {% endtabs %} *** ## Source {% hint style="info" %} A Fide Source will always have a digital location such as a blockchain address or url. {% endhint %} {% content-ref url="/pages/FoTYhx6YtWcDAUhviZrs" %} [Source Schema](/api/source-schema) {% endcontent-ref %} ## Get information for a Fide source entity identified by a unique Fide Source ID. `POST` `https://api.fide.id/source` #### Request Body | Name | Type | Description | | -------------------------------------------- | ------ | ----------- | | source\_id\* | string | | {% tabs %} {% tab title="200: OK dictionary" %} {% endtab %} {% endtabs %} ## Build a list of Fide sources filtered by a unique query. `POST` `https://api.fide.id/sources` #### Request Body | Name | Type | Description | | --------------------------------------- | ---------- | ----------------------------------------------------- | | query\* | dictionary | [Broken mention](broken://pages/97XP4Wk3qyI4f9v1aZRM) | {% tabs %} {% tab title="200: OK dictionary\[]" %} {% endtab %} {% endtabs %} *** ## Contribution {% hint style="info" %} A Fide Contribution will always represent a one-way relationship between two entities, sources, and/or contributions. {% endhint %} {% content-ref url="/pages/x5eaHDSx4K3kPwpnNQVa" %} [Contribution Schema](/api/contribution-schema) {% endcontent-ref %} ## Get information for a single contribution identified by a unique Fide Contribution ID. `POST` `https://api.fide.id/contribution` #### Request Body | Name | Type | Description | | ------------------------------------------ | ------ | ----------------------------------------------------- | | fide\_id\* | string | [Broken mention](broken://pages/97XP4Wk3qyI4f9v1aZRM) | {% tabs %} {% tab title="200: OK dictionary" %} {% endtab %} {% endtabs %}