Support tickets

Create a new ticket or manage your existing tickets

Transaction disputes

Dispute a deal or report others for scamming

V1 Endpoints

  • Last updated Last updated:

  • Contents

    Health​

    Retrieve a health status

    We expect this endpoint to always return a successful response under nominal conditions.

    Use this to assess whether subsequent calls to other endpoints will likely succeed. For example, it would be handy to make a request to this endpoint during the initialisation of a wrapper to verify that a valid authentication token has been provided and that there aren't any temporary internal server or database errors.

    Token Type
    Private & Shared

    Method/URL
    GET https://api.builtbybit.com/v1/health

    Response Data
    A string with content "ok".
    ​

    Alerts​

    List unread alerts

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/alerts

    Sortable Fields
    "caused_member_id"
    "content_type"
    "content_id"
    "alert_type"
    "alert_date" (default)

    Response Data
    An array of Alert objects.
    ​
    Mark unread alerts as read

    Token Type
    Private

    Method/URL
    PATCH https://api.builtbybit.com/v1/alerts

    Body Parameters
    "read" - expects a boolean (should always be true)
    ​

    Conversations​

    List unread conversations

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/conversations

    Sortable Fields
    "creation_date"
    "creator_id"
    "title"
    "reply_count"
    "last_message_date" (default)
    "last_read_date"

    Response Data
    An array of Conversation objects.
    ​
    Start a new conversation

    Token Type
    Private

    Method/URL
    POST https://api.builtbybit.com/v1/conversations

    Body Parameters
    "recipient_ids" - expects an array of member identifiers (non-negative integers)
    "title" - expects a string
    "message" - expects a string

    Response Data
    An unsigned integer representing the newly created conversation's identifier.
    ​

    Replies​

    List replies to an unread conversation

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/conversations/{id}/replies

    Path Parameters
    "id" - expects a conversation identifier (non-negative integer)

    Sortable Fields
    "author_id"
    "message_date" (default)
    "message"

    Response Data
    An array of Reply objects.
    ​
    Reply to an unread conversation

    Token Type
    Private

    Method/URL
    POST https://api.builtbybit.com/v1/conversations/{id}/replies

    Path Parameters
    "id" - expects a conversation identifier (non-negative integer)

    Body Parameters
    "message" - expects a string

    Response Data
    An unsigned integer representing the newly created reply's identifier.
    ​

    Members​

    Retrieve information about yourself

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/members/self

    Response Data
    A Member object.
    ​
    Modify information about yourself

    Token Type
    Private

    Method/URL
    PATCH https://api.builtbybit.com/v1/members/self

    Body Parameters
    "custom_title" - expects a string, but is optional
    "about_me" - expects a string, but is optional
    "signature" - expects a string, but is optional
    ​
    Retrieve information about a member by ID

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/members/{id}

    Path Parameters
    "id" - expects a non-negative integer

    Response Data
    A Member object.
    ​
    Retrieve information about a member by username

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/members/usernames/{name}

    Path Parameters
    "name" - expects a string

    Response Data
    A Member object.
    ​
    Retrieve information about a member by Discord identifier

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/members/discords/{discord_id}

    Path Parameters
    "discord_id" - expects a non-negative integer

    Response Data
    A Member object.
    ​
    List recently issued bans

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/members/bans

    Response Data
    An array of Ban objects.
    ​

    Profile Posts​

    List profile posts on your profile

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/members/self/profile-posts

    Sortable Fields
    "author_id"
    "post_date" (default)
    "message"
    "comment_count"

    Response Data
    An array of ProfilePost objects.
    ​
    Retrieve a specific profile post on your profile

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/members/self/profile-posts/{id}

    Path Parameters
    "id" - expects a non-negative integer

    Response Data
    A ProfilePost object.
    ​
    Edit a specific profile post you've authored on your profile

    Token Type
    Private

    Method/URL
    PATCH https://api.builtbybit.com/v1/members/self/profile-posts/{id}

    Path Parameters
    "id" - expects a non-negative integer

    Body Parameters
    "message" - expects a string
    ​
    Delete a specific profile post you've authored on your profile

    Token Type
    Private

    Method/URL
    DELETE https://api.builtbybit.com/v1/members/self/profile-posts/{id}

    Path Parameters
    "id" - expects a non-negative integer
    ​

    Resources​

    List public resources

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/resources

    Sortable Fields
    "last_update_date" (default)
    "submission_date"
    "title"
    "downloads"
    "rating"
    "purchase_count"
    "price"

    Response Data
    An array of BasicResource objects.
    ​
    List owned resources

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/resources/owned

    Sortable Fields
    "last_update_date" (default)
    "submission_date"
    "title"
    "downloads"
    "rating"
    "purchase_count"
    "price"

    Response Data
    An array of BasicResource objects.
    ​
    List collaborated resources

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/resources/collaborated

    Sortable Fields
    "last_update_date" (default)
    "submission_date"
    "title"
    "downloads"
    "rating"
    "purchase_count"
    "price"

    Response Data
    An array of BasicResource objects.
    ​
    List resources by author

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/resources/authors/{id}

    Path Parameters
    "id" - a string representing the resource author's identifier

    Sortable Fields
    "last_update_date" (default)
    "submission_date"
    "title"
    "downloads"
    "rating"
    "purchase_count"
    "price"

    Response Data
    An array of BasicResource objects.
    ​
    Retrieve data about a resource

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/resources/{id}

    Path Parameters
    "id" - a string representing the resource's identifier

    Response Data
    A Resource object.
    ​
    Modify a resource

    Token Type
    Private

    Method/URL
    PATCH https://api.builtbybit.com/v1/resources/{id}

    Path Parameters
    "id" - a string representing the resource's identifier

    Body Parameters
    "title" - expects a string
    "tag_line" - expects a string
    "description" - expects a string
    ​
    Submit resources for batch editing

    Batch edits will be processed in the background meaning a successful call to this endpoint does not guarantee that the edits have been completed. You will instead receive an identifier to a batch edit which you can then use to fetch the status of via the below endpoint. This is not an atomic operation meaning some resources may be edited successfully and others may not be due to an error. You may only batch edit resources you own currently. Resource fields are batch editable depending on their type:

    Numeric:
    - "absolute" - set an absolute numeric value (ie. override the existing value)
    - "fixed" - increase the value by a fixed amount (use negative values to decrease)
    - "percent" - increase the value by a percentage (use negative percentages to decrease)

    String:
    - "absolute" - set an absolute string value (ie. override the existing value)
    - "str-replace" - replaces all occurrences of the search string with the replacement string
    - "regex-replace" - replaces all matches of the regex with the replacement string

    Enum:
    - "absolute" - set an absolute string value (ie. override the existing value)

    Editable fields:
    "title" - string
    "tag-line" - string
    "description" - string
    "price" - numeric
    "visibility" - enum ("visible", "unlisted", "unpublished")

    Token Type
    Private

    Method/URL
    POST https://api.builtbybit.com/v1/resources/batch/

    Body Parameters
    "resources" - expects an array of unsigned integers representing the identifiers of resources to be edited
    "changes" - expects an array of changes as described below.

    A change has four fields:
    "field" - the resource field to edit, as described below
    "type" - the type of change being made as described below
    "value" - the value to perform the operation against
    "search" - a string or pattern to search for (only relevant for str-replace or regex-replace)

    Response Data
    An unsigned integer representing the newly created batch edit's identifier.
    ​
    Retrieve batch editing results

    Allows you to fetch the status of a batch edit. The batch processing is complete when completed_at != 0. A resource encountering one or more errors means the edit failed and did not save successfully. The results of batch edits will be preserved for a minimum of 30 days.

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/resources/batch/{id}

    Path Parameters
    "id" - expects a batch edit identifier (non-negative integer)

    Response Data
    A BatchEdit object.
    ​

    Versions​

    List resource versions

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/resources/{id}/versions

    Path Parameters
    "id" - a non-negative integer representing the resource's identifier

    Sortable Fields
    "release_date" (default)
    "name"
    "download_count"

    Response Data
    An array of Version objects.
    ​
    Retrieve the latest resource version

    Token Type
    Private & Shared

    Method/URL
    GET https://api.builtbybit.com/v1/resources/{id}/versions/latest

    Path Parameters
    "id" - a non-negative integer representing the resource's identifier

    Response Data
    A Version object.
    ​
    Retrieve a specific resource version

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/resources/{r_id}/versions/{v_id}

    Path Parameters
    "r_id" - a non-negative integer representing the resource's identifier
    "v_id" - a non-negative integer representing the version's identifier

    Response Data
    A Version object.
    ​
    Delete a version

    Token Type
    Private

    Method/URL
    DELETE https://api.builtbybit.com/v1/resources/{r_id}/versions/{v_id}

    Path Parameters
    "r_id" - a non-negative integer representing the resource's identifier
    "v_id" - a non-negative integer representing the version's identifier
    ​

    Updates​

    List resource updates

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/resources/{id}/updates

    Path Parameters
    "id" - a non-negative integer representing the resource's identifier

    Sortable Fields
    "update_date" (default)
    "title"
    "message"

    Response Data
    An array of Update objects.
    ​
    Retrieve the latest update

    Token Type
    Private & Shared

    Method/URL
    GET https://api.builtbybit.com/v1/resources/{id}/updates/latest

    Path Parameters
    "id" - a non-negative integer representing the resource's identifier

    Response Data
    An Update object.
    ​
    Retrieve an update

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/resources/{r_id}/updates/{u_id}

    Path Parameters
    "r_id" - a non-negative integer representing the resource's identifier
    "u_id" - a non-negative integer representing the update's identifier

    Response Data
    An Update object.
    ​
    Delete an update

    Token Type
    Private

    Method/URL
    DELETE https://api.builtbybit.com/v1/resources/{r_id}/updates/{u_id}

    Path Parameters
    "r_id" - a non-negative integer representing the resource's identifier
    "u_id" - a non-negative integer representing the update's identifier
    ​

    Reviews​

    List resource reviews

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/resources/{id}/reviews

    Path Parameters
    "id" - expects a non-negative integer representing the resource's identifier

    Sortable Fields
    "review_date" (default)
    "reviewer_id"
    "rating"
    "message"
    "response"

    Response Data
    An array of Review objects.
    ​
    Retrieve a member's resource review

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/resources/{r_id}/reviews/members/{m_id}

    Path Parameters
    "r_id" - expects a non-negative integer representing the resource's identifier
    "m_id" - expects a non-negative integer representing the review's identifier

    Response Data
    A Review object.
    ​
    Respond to a resource review

    Token Type
    Private

    Method/URL
    PATCH https://api.builtbybit.com/v1/resources/{res_id}/reviews/{rev_id}

    Path Parameters
    "res_id" - expects a non-negative integer representing the resource's identifier
    "rev_id" - expects a non-negative integer representing the review's identifier

    Body Parameters
    "response" - expects a string
    ​

    Purchases​

    List resource purchases

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/resources/{id}/purchases

    Path Parameters
    "id" - expects a non-negative integer representing the resource's identifier

    Sortable Fields
    "purchase_date" (default)
    "validation_date"
    "purchase_id"
    "purchaser_id"
    "license_id"
    "renewal"
    "status"
    "price"
    "currency"

    Response Data
    An array of Purchase objects.
    ​
    Retrieve a resource purchase

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/resources/{r_id}/purchases/{p_id}

    Path Parameters
    "r_id" - expects a non-negative integer representing the resource's identifier
    "p_id" - expects a non-negative integer representing the purchase's identifier

    Response Data
    A Purchase object.
    ​

    Licenses​

    List resource licenses

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/resources/{id}/licenses

    Path Parameters
    "id" - expects a non-negative integer representing the resource's identifier

    Sortable Fields
    "start_end" (default)
    "end_date"
    "previous_end_date"
    "license_id"
    "purchaser_id"
    "validated"
    "active"

    Response Data
    An array of License objects.
    ​
    Retrieve a resource license

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/resources/{r_id}/licenses/{l_id}

    Path Parameters
    "r_id" - a non-negative integer representing the resource's identifier
    "l_id" - a non-negative integer representing the license's identifier

    Response Data
    A License object.
    ​
    Modify a resource license
    When modifying a license to be permanent, only the 'active' optional body parameter should be set.
    When modifying a license to be temporary, only the 'start_date' and 'end_date' optional body parameters should be set.

    Token Type
    Private

    Method/URL
    PATCH https://api.builtbybit.com/v1/resources/{r_id}/licenses/{l_id}

    Path Parameters
    "r_id" - a non-negative integer representing the resource's identifier
    "l_id" - a non-negative integer representing the license's identifier

    Body Parameters
    "permanent" - expects a boolean
    "active" - optional, expects a boolean
    "start_date" - optional, expects a UNIX timestamp
    "end_date" - optional, expects a UNIX timestamp
    ​
    Retrieve a resource license by member

    We expect this endpoint to be used in conjunction with our anti-piracy placeholders to ensure that requests attempting to validate a license for a specific purchaser only succeed when we can be confident the request originated from that specific purchaser, and not another member of our platform.

    Thus, when making a request to this endpoint via a Shared token type, we require that the "nonce" and "timestamp" anti-piracy placeholders be included as query parameters. These query parameters are ignored when making a request to this endpoint via a Private token type.

    Token Type
    Private & Shared

    Method/URL
    GET https://api.builtbybit.com/v1/resources/{r_id}/licenses/members/{m_id}

    Path Parameters
    "r_id" - a non-negative integer representing the resource's identifier
    "m_id" - a non-negative integer representing the member's identifier

    Query Parameters
    "nonce" - expects a non-negative integer
    "date" - expects a UNIX timestamp

    Response Data
    A License object.
    ​

    Downloads​

    List resource downloads

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/resources/{id}/downloads

    Path Parameters
    "id" - expects a non-negative integer

    Sortable Fields
    "download_date" (default)
    "version_id"
    "downloader_id"

    Response Data
    An array of Download objects.
    ​
    List resource downloads by member

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/resources/{r_id}/downloads/members/{m_id}

    Path Parameters
    "r_id" - expects a non-negative integer representing the resource's identifier
    "m_id" - expects a non-negative integer representing the member's identifier

    Sortable Fields
    "download_date" (default)
    "version_id"

    Response Data
    An array of Download objects.
    ​
    List resource downloads by version

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/resources/{r_id}/downloads/versions/{v_id}

    Path Parameters
    "r_id" - expects a non-negative integer representing the resource's identifier
    "v_id" - expects a non-negative integer representing the version's identifier

    Sortable Fields
    "download_date" (default)
    "downloader_id"

    Response Data
    An array of Download objects.
    ​

    Addons​

    List purchases for a given addon

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/addons/{id}/purchases/

    Response Data
    An array of AddonPurchase objects.
    ​
    Lookup addon purchases by member

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/addons/{a_id}/purchases/member/{m_id}/

    Path Paramteres
    "a_id" - expects a non-negative integer representing the addon's identifier
    "m_id" - expects a non-negative integer representing the member's identifier

    Response Data
    An array of AddonPurchase objects.
    ​
    List licenses for a given addon

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/addons/{id}/licenses/

    Response Data
    An array of AddonLicense objects.
    ​
    Lookup addon licenses by member

    Token Type
    Private

    Method/URL
    GET https://api.builtbybit.com/v1/addons/{a_id}/licenses/member/{m_id}/

    Path Paramteres
    "a_id" - expects a non-negative integer representing the addon's identifier
    "m_id" - expects a non-negative integer representing the member's identifier

    Response Data
    An array of AddonLicense objects.
    ​

    API Assets​

    Request an API asset download

    Token Type
    Private & Shared

    Method/URL
    GET https://api.builtbybit.com/v1/api-assets/{asset_id}

    Path Paramteres
    "asset_id" - a non-negative integer representing the asset’s identifier (can be found in the title of the asset’s edit UI)

    Query Parameters
    "nonce" - required, 32 character hash provided by an anti-piracy placeholder of the NONCE type. Must be from a resource download (cannot be an addon download’s nonce, etc)
    "access_token" - required when checking the status of a download request after a request has been generated by making an initial request without an access token

    Response Data
    Upon first request:
    JSON: 
    {
    
    access_token: string,
    
    ttl: unsigned int
    
}

    Upon subsequent requests with the access token:
    JSON: 
    {
    
    retry: bool,
    
    url: optional string
    
}

    When retry is true, a URL is not yet available or provided. When false, a pre-signed URL at which the asset may be temporarily downloaded from is provided in the response body. If the download URL has expired, an error will be returned, and you should discard the token and submit a new request.
    ​
Top